All Classes

Class
Description
Middleware to add the header Accept: gzip to the request
This is the generic error code for access denied.
AccessDeniedErrorBuilder Example to create an instance using the builder pattern
This is the generic error code for access denied.
abstract class for accessor implementations
Change triggered by the Add Address update action.
AddAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Address update action.
Change triggered by the following update actions:
AddAssetChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Add Attribute Definition update action.
AddAttributeDefinitionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Attribute Definition update action.
Change triggered by the Add Billing Address ID update action.
AddBillingAddressIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Billing Address ID update action.
Change triggered by the Add Roles update action.
AddChannelRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Roles update action.
Change triggered by the Add CustomLineItem update action.
AddCustomLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add CustomLineItem update action.
Change triggered by the Add Delivery update action.
AddDeliveryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Delivery update action.
Change triggered by the Add DiscountCode update action.
AddDiscountCodeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add DiscountCode update action.
Change triggered by the Add EnumValue to FieldDefinition update action.
AddEnumValueChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add EnumValue to FieldDefinition update action.
Change triggered by the Add External Image update action.
AddExternalImageChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add External Image update action.
Change triggered by the Add FieldDefinition update action.
AddFieldDefinitionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add FieldDefinition update action.
Change triggered by the Add InterfaceInteraction update action.
AddInterfaceInteractionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add InterfaceInteraction update action.
Change triggered by the following update actions:
AddItemShippingAddressesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
AddLocalizedEnumValueChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Add Location update action.
AddLocationChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Location update action.
Change triggered by the Add LineItem update action.
AddOrderLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add LineItem update action.
Change triggered by the following update actions:
AddParcelToDeliveryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
AddPaymentChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Add PlainEnumValue to AttributeDefinition update action.
AddPlainEnumValueChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add PlainEnumValue to AttributeDefinition update action.
Change triggered by the Add Price update action.
AddPriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Price update action.
Change triggered by the Add Product update action.
AddProductChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Product update action.
Change triggered by the Update CustomObject request when a new property is added.
AddPropertyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when a new property is added.
Address type returned by read methods.
Address Example to create an instance using the builder pattern
Address Example to create an instance using the builder pattern
AddressBuilder Example to create an instance using the builder pattern
AddressBuilder Example to create an instance using the builder pattern
AddressBuilder Example to create an instance using the builder pattern
Address type to be used on write methods.
AddressDraftBuilder Example to create an instance using the builder pattern
Address type to be used on write methods.
 
Address type returned by read methods.
Address
Address
 
Change triggered by the following update actions:
AddReturnInfoChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Add Shipping Address ID update action.
AddShippingAddressIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Shipping Address ID update action.
Change triggered by the Add ShoppingListLineItem update action.
AddShoppingListLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add ShoppingListLineItem update action.
Change triggered by the Add State roles update action.
AddStateRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add State roles update action.
Change triggered by the Add TaxRate update action.
AddTaxRateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add TaxRate update action.
Change triggered by the Add TextLineItem update action.
AddTextLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add TextLineItem update action.
Change triggered by the Add to Category update action.
AddToCategoryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add to Category update action.
Change triggered by the Add Transaction update action.
AddTransactionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add Transaction update action.
Change triggered by the Add ProductVariant update action.
AddVariantChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Add ProductVariant update action.
AnonymousCartSignInMode
possible values of AnonymousCartSignInMode
 
Returned when the anonymous ID is being used by another resource.
AnonymousIdAlreadyInUseErrorBuilder Example to create an instance using the builder pattern
Returned when the anonymous ID is being used by another resource.
 
Token supplier using anonymous flow
 
ApiClient Example to create an instance using the builder pattern
ApiClientBuilder Example to create an instance using the builder pattern
ApiClientDraft Example to create an instance using the builder pattern
ApiClientDraftBuilder Example to create an instance using the builder pattern
ApiClientDraft
 
 
ApiClient
PagedQueryResult with results containing an array of APIClient.
ApiClientPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of APIClient.
 
 
CorrelationIdProvider which adds the project key as prefix
 
Deprecated.
use ApiRootBuilder instead
Interface for an HTTP client accessing the API and mapping to a known output type
Default implementation of an ApiHttpClient
 
Creates an exception bases on the status code of the ApiHttpResponse with module specific exception for BadRequestException and ConcurrentModificationException
 
 
 
 
 
 
 
Creates an InternalLogger with the API path of the request
 
 
Module to configure the default jackson ObjectMapper e.g.
 
 
Entrypoint for building requests against the API
Entrypoint for building requests against the API
Entrypoint for building requests against the API
Entrypoint for building requests against the API
Builder to create a ApiRoot or a project scoped ProjectApiRoot
 
Asset Example to create an instance using the builder pattern
Asset Example to create an instance using the builder pattern
Asset Example to create an instance using the builder pattern
AssetBuilder Example to create an instance using the builder pattern
AssetBuilder Example to create an instance using the builder pattern
AssetBuilder Example to create an instance using the builder pattern
AssetChangeValue Example to create an instance using the builder pattern
AssetChangeValueBuilder Example to create an instance using the builder pattern
AssetChangeValue
Dimensions of the Asset source specified by the number of pixels.
AssetDimensions Example to create an instance using the builder pattern
The width and height of the Asset Source.
AssetDimensionsBuilder Example to create an instance using the builder pattern
AssetDimensionsBuilder Example to create an instance using the builder pattern
AssetDimensionsBuilder Example to create an instance using the builder pattern
Dimensions of the Asset source specified by the number of pixels.
AssetDimensions
The width and height of the Asset Source.
 
AssetDraft Example to create an instance using the builder pattern
AssetDraftBuilder Example to create an instance using the builder pattern
AssetDraft
 
Asset
Asset
Asset
 
Representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.
AssetSource Example to create an instance using the builder pattern
An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
AssetSourceBuilder Example to create an instance using the builder pattern
AssetSourceBuilder Example to create an instance using the builder pattern
AssetSourceBuilder Example to create an instance using the builder pattern
Representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.
AssetSource
An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
 
AssignedProductReference Example to create an instance using the builder pattern
AssignedProductReferenceBuilder Example to create an instance using the builder pattern
AssignedProductReference
 
AssignedProductSelection Example to create an instance using the builder pattern
AssignedProductSelectionBuilder Example to create an instance using the builder pattern
AssignedProductSelection
PagedQueryResult containing an array of AssignedProductSelection.
AssignedProductSelectionPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductSelection.
 
 
Associate Example to create an instance using the builder pattern
AssociateBuilder Example to create an instance using the builder pattern
AssociateDraft Example to create an instance using the builder pattern
AssociateDraftBuilder Example to create an instance using the builder pattern
AssociateDraft
 
Associate
Returned when an Associate is missing a Permission on a B2B resource.
AssociateMissingPermissionErrorBuilder Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
 
 
AssociateRole Example to create an instance using the builder pattern
Adding a Permission to an AssociateRole generates an AssociateRolePermissionAdded Message.
AssociateRoleAddPermissionActionBuilder Example to create an instance using the builder pattern
Adding a Permission to an AssociateRole generates an AssociateRolePermissionAdded Message.
 
AssociateRoleAssignment Example to create an instance using the builder pattern
AssociateRoleAssignmentBuilder Example to create an instance using the builder pattern
AssociateRoleAssignmentDraft Example to create an instance using the builder pattern
AssociateRoleAssignmentDraftBuilder Example to create an instance using the builder pattern
AssociateRoleAssignmentDraft
 
AssociateRoleAssignment
 
AssociateRoleBuilder Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
AssociateRoleBuyerAssignableChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
Generated after a successful Change BuyerAssignable update action.
AssociateRoleBuyerAssignableChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
 
 
Changing the buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.
AssociateRoleChangeBuyerAssignableActionBuilder Example to create an instance using the builder pattern
Changing the buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.
 
Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
 
 
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
 
 
Roles defining how an Associate can interact with a Business Unit.
possible values of AssociateRoleDeprecated
AssociateRoleDraft Example to create an instance using the builder pattern
AssociateRoleDraftBuilder Example to create an instance using the builder pattern
AssociateRoleDraft
 
AssociateRole
Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
possible values of AssociateRoleInheritanceMode
Reference to an AssociateRole by its key.
AssociateRoleKeyReferenceBuilder Example to create an instance using the builder pattern
Reference to an AssociateRole by its key.
 
Generated after a successful Set Name update action.
AssociateRoleNameChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
Generated after a successful Set Name update action.
AssociateRoleNameChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
 
 
PagedQueryResult with results containing an array of AssociateRole.
AssociateRolePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of AssociateRole.
 
Generated after a successful Add Permissions update action.
AssociateRolePermissionAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Permissions update action.
Generated after a successful Add Permissions update action.
AssociateRolePermissionAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Permissions update action.
 
 
Generated after a successful Remove Permissions update action.
AssociateRolePermissionRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Permissions update action.
Generated after a successful Remove Permissions update action.
AssociateRolePermissionRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Permissions update action.
 
 
Generated after a successful Set Permissions update action.
AssociateRolePermissionsSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Permissions update action.
Generated after a successful Set Permissions update action.
AssociateRolePermissionsSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Permissions update action.
 
 
 
Reference to an AssociateRole.
AssociateRoleReferenceBuilder Example to create an instance using the builder pattern
Reference to an AssociateRole.
 
Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
AssociateRoleRemovePermissionActionBuilder Example to create an instance using the builder pattern
Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
 
ResourceIdentifier of an AssociateRole.
AssociateRoleResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier of an AssociateRole.
 
AssociateRoleSetCustomFieldAction Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldActionBuilder Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldAction
 
AssociateRoleSetCustomTypeAction Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeActionBuilder Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeAction
 
Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
AssociateRoleSetNameActionBuilder Example to create an instance using the builder pattern
Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
 
Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
AssociateRoleSetPermissionsActionBuilder Example to create an instance using the builder pattern
Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
 
AssociateRoleUpdate Example to create an instance using the builder pattern
AssociateRoleUpdateAction Example to create a subtype instance using the builder pattern
AssociateRoleUpdateActionBuilder
AssociateRoleUpdateAction
 
AssociateRoleUpdateBuilder Example to create an instance using the builder pattern
AssociateRoleUpdate
 
 
Attribute Example to create an instance using the builder pattern
This type represents the value of an attribute of a product variant.
Accessor for retrieving type safe attribute values
Deprecated.
use AttributeAccessor instead
Attribute type for Boolean values.
AttributeBooleanType Example to create an instance using the builder pattern
AttributeBooleanTypeBuilder Example to create an instance using the builder pattern
AttributeBooleanTypeBuilder Example to create an instance using the builder pattern
Attribute type for Boolean values.
AttributeBooleanType
 
AttributeBuilder Example to create an instance using the builder pattern
AttributeBuilder
Specifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product:
AttributeConstraintEnum
AttributeConstraintEnum
possible values of AttributeConstraintEnum
possible values of AttributeConstraintEnum
possible values of AttributeConstraintEnum
AttributeConstraintEnumDraft
possible values of AttributeConstraintEnumDraft
 
AttributeDateTimeType Example to create an instance using the builder pattern
AttributeDateTimeType Example to create an instance using the builder pattern
AttributeDateTimeTypeBuilder Example to create an instance using the builder pattern
AttributeDateTimeTypeBuilder Example to create an instance using the builder pattern
AttributeDateTimeType
AttributeDateTimeType
 
AttributeDateType Example to create an instance using the builder pattern
AttributeDateType Example to create an instance using the builder pattern
AttributeDateTypeBuilder Example to create an instance using the builder pattern
AttributeDateTypeBuilder Example to create an instance using the builder pattern
AttributeDateType
AttributeDateType
 
Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
AttributeDefinition Example to create an instance using the builder pattern
AttributeDefinition Example to create an instance using the builder pattern
Returned when the name of the AttributeDefinition conflicts with an existing Attribute.
AttributeDefinitionAlreadyExistsErrorBuilder Example to create an instance using the builder pattern
Returned when the name of the AttributeDefinition conflicts with an existing Attribute.
 
AttributeDefinitionBuilder Example to create an instance using the builder pattern
AttributeDefinitionBuilder Example to create an instance using the builder pattern
AttributeDefinitionBuilder Example to create an instance using the builder pattern
 
Specify the Attribute to be created with the ProductTypeDraft.
AttributeDefinitionDraftBuilder Example to create an instance using the builder pattern
Specify the Attribute to be created with the ProductTypeDraft.
 
Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
AttributeDefinition
AttributeDefinition
 
Returned when the type is different for an AttributeDefinition using the same name in multiple Product Types.
AttributeDefinitionTypeConflictErrorBuilder Example to create an instance using the builder pattern
Returned when the type is different for an AttributeDefinition using the same name in multiple Product Types.
 
Attribute type for plain enum values.
AttributeEnumType Example to create an instance using the builder pattern
AttributeEnumTypeBuilder Example to create an instance using the builder pattern
AttributeEnumTypeBuilder Example to create an instance using the builder pattern
Attribute type for plain enum values.
AttributeEnumType
 
AttributeGroup Example to create an instance using the builder pattern
AttributeGroupAddAttributeAction Example to create an instance using the builder pattern
AttributeGroupAddAttributeActionBuilder Example to create an instance using the builder pattern
AttributeGroupAddAttributeAction
 
AttributeGroupBuilder Example to create an instance using the builder pattern
AttributeGroupChangeNameAction Example to create an instance using the builder pattern
AttributeGroupChangeNameActionBuilder Example to create an instance using the builder pattern
AttributeGroupChangeNameAction
 
AttributeGroupDraft Example to create an instance using the builder pattern
AttributeGroupDraftBuilder Example to create an instance using the builder pattern
AttributeGroupDraft
 
AttributeGroup
PagedQueryResult with results containing an array of AttributeGroup.
AttributeGroupPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of AttributeGroup.
 
 
Reference to an AttributeGroup.
AttributeGroupReferenceBuilder Example to create an instance using the builder pattern
Reference to an AttributeGroup.
 
AttributeGroupRemoveAttributeAction Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeActionBuilder Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeAction
 
ResourceIdentifier to an AttributeGroup.
AttributeGroupResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to an AttributeGroup.
 
AttributeGroupSetAttributesAction Example to create an instance using the builder pattern
AttributeGroupSetAttributesActionBuilder Example to create an instance using the builder pattern
AttributeGroupSetAttributesAction
 
AttributeGroupSetDescriptionAction Example to create an instance using the builder pattern
AttributeGroupSetDescriptionActionBuilder Example to create an instance using the builder pattern
AttributeGroupSetDescriptionAction
 
AttributeGroupSetKeyAction Example to create an instance using the builder pattern
AttributeGroupSetKeyActionBuilder Example to create an instance using the builder pattern
AttributeGroupSetKeyAction
 
AttributeGroupUpdate Example to create an instance using the builder pattern
AttributeGroupUpdateAction Example to create a subtype instance using the builder pattern
AttributeGroupUpdateActionBuilder
AttributeGroupUpdateAction
 
AttributeGroupUpdateBuilder Example to create an instance using the builder pattern
AttributeGroupUpdate
 
Attribute
This type represents the value of an attribute of a product variant.
Attribute type for LocalizedString values.
AttributeLocalizableTextType Example to create an instance using the builder pattern
AttributeLocalizableTextTypeBuilder Example to create an instance using the builder pattern
AttributeLocalizableTextTypeBuilder Example to create an instance using the builder pattern
Attribute type for LocalizedString values.
AttributeLocalizableTextType
 
Attribute type for localized enum values.
AttributeLocalizedEnumType Example to create an instance using the builder pattern
AttributeLocalizedEnumTypeBuilder Example to create an instance using the builder pattern
AttributeLocalizedEnumTypeBuilder Example to create an instance using the builder pattern
Attribute type for localized enum values.
AttributeLocalizedEnumType
 
A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributeLocalizedEnumValue Example to create an instance using the builder pattern
AttributeLocalizedEnumValueBuilder Example to create an instance using the builder pattern
AttributeLocalizedEnumValueBuilder Example to create an instance using the builder pattern
A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributeLocalizedEnumValue
 
AttributeMoneyType Example to create an instance using the builder pattern
AttributeMoneyType Example to create an instance using the builder pattern
AttributeMoneyTypeBuilder Example to create an instance using the builder pattern
AttributeMoneyTypeBuilder Example to create an instance using the builder pattern
AttributeMoneyType
AttributeMoneyType
 
Returned when an AttributeDefinition does not exist for an Attribute name.
AttributeNameDoesNotExistErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute name.
 
Attribute type for nesting Attributes based on some existing ProductType.
AttributeNestedType Example to create an instance using the builder pattern
AttributeNestedTypeBuilder Example to create an instance using the builder pattern
AttributeNestedTypeBuilder Example to create an instance using the builder pattern
Attribute type for nesting Attributes based on some existing ProductType.
AttributeNestedType
 
AttributeNumberType Example to create an instance using the builder pattern
AttributeNumberType Example to create an instance using the builder pattern
AttributeNumberTypeBuilder Example to create an instance using the builder pattern
AttributeNumberTypeBuilder Example to create an instance using the builder pattern
AttributeNumberType
AttributeNumberType
 
A plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributePlainEnumValue Example to create an instance using the builder pattern
AttributePlainEnumValueBuilder Example to create an instance using the builder pattern
AttributePlainEnumValueBuilder Example to create an instance using the builder pattern
A plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributePlainEnumValue
 
 
 
AttributeReference Example to create an instance using the builder pattern
AttributeReferenceBuilder Example to create an instance using the builder pattern
AttributeReference
 
AttributeReferenceType Example to create an instance using the builder pattern
AttributeReferenceType Example to create an instance using the builder pattern
AttributeReferenceTypeBuilder Example to create an instance using the builder pattern
AttributeReferenceTypeBuilder Example to create an instance using the builder pattern
Name of the resource type that the value should reference.
possible values of AttributeReferenceTypeId
AttributeReferenceType
AttributeReferenceType
 
Attributes Example to create an instance using the builder pattern
Accessor to retrieve attribute values type safe
AttributesBuilder Example to create an instance using the builder pattern
 
AttributeType that defines a set (without duplicate elements) with values of the given elementType.
AttributeSetType Example to create an instance using the builder pattern
AttributeSetTypeBuilder Example to create an instance using the builder pattern
AttributeSetTypeBuilder Example to create an instance using the builder pattern
AttributeType that defines a set (without duplicate elements) with values of the given elementType.
AttributeSetType
 
Attributes
 
Attribute type for plain text values.
AttributeTextType Example to create an instance using the builder pattern
AttributeTextTypeBuilder Example to create an instance using the builder pattern
AttributeTextTypeBuilder Example to create an instance using the builder pattern
Attribute type for plain text values.
AttributeTextType
 
AttributeTimeType Example to create an instance using the builder pattern
AttributeTimeType Example to create an instance using the builder pattern
AttributeTimeTypeBuilder Example to create an instance using the builder pattern
AttributeTimeTypeBuilder Example to create an instance using the builder pattern
AttributeTimeType
AttributeTimeType
 
Umbrella type for specific attribute types discriminated by property name.
AttributeType Example to create an instance using the builder pattern
AttributeType Example to create a subtype instance using the builder pattern
AttributeTypeBuilder
AttributeTypeBuilder Example to create an instance using the builder pattern
AttributeTypeBuilder
Umbrella type for specific attribute types discriminated by property name.
AttributeType
AttributeType
 
AttributeValue Example to create an instance using the builder pattern
AttributeValueBuilder Example to create an instance using the builder pattern
AttributeValue
AuthenticationMode
AuthenticationMode
AuthenticationMode
possible values of AuthenticationMode
possible values of AuthenticationMode
possible values of AuthenticationMode
 
Represents errors related to authentication and authorization in a format conforming to the OAuth 2.0 specification.
AuthErrorResponseBuilder Example to create an instance using the builder pattern
Represents errors related to authentication and authorization in a format conforming to the OAuth 2.0 specification.
 
 
The Authorization header will be set to the content of headerValue.
AuthorizationHeaderAuthenticationBuilder Example to create an instance using the builder pattern
The Authorization header will be set to the content of headerValue.
 
 
Defines the method of authentication for AWS SQS and SNS Destinations.
possible values of AwsAuthenticationMode
We recommend creating an Identify and Access Management (IAM) user with an accessKey and accessSecret pair, specifically for each Extension that only has the lambda:InvokeFunction permission on this function.
AWSLambdaDestinationBuilder Example to create an instance using the builder pattern
We recommend creating an Identify and Access Management (IAM) user with an accessKey and accessSecret pair, specifically for each Extension that only has the lambda:InvokeFunction permission on this function.
 
Azure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.
AzureEventGridDestinationBuilder Example to create an instance using the builder pattern
Azure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.
 
To protect your Azure Function, set its authLevel to function and provide the function's key to be used inside the x-functions-key header.
AzureFunctionsAuthenticationBuilder Example to create an instance using the builder pattern
To protect your Azure Function, set its authLevel to function and provide the function's key to be used inside the x-functions-key header.
 
Azure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.
AzureServiceBusDestinationBuilder Example to create an instance using the builder pattern
Azure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.
 
Returned when a server-side problem is caused by scaling infrastructure resources.
BadGatewayErrorBuilder Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
 
 
Deserializes the response payload as ErrorResponse
 
Polymorphic base type that represents a postal address and contact details.
BaseAddressBuilder Example to create an instance using the builder pattern
Polymorphic base type that represents a postal address and contact details.
 
 
 
Exception hierarchy
In order to work, the sdk needs an VrapHttpClient provider, this can be done by extending HttpClientSupplier and exposing it as a service
BaseResource Example to create an instance using the builder pattern
BaseResource
 
MoneyProvider which uses the Money implementation with BigDecimals.
 
 
 
This type represents an attribute whose value is either "true" or "false".
BooleanAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is either "true" or "false".
 
A field with a boolean value.
BooleanFieldBuilder Example to create an instance using the builder pattern
A field with a boolean value.
This type represents an attribute whose value is set of boolean values.
BooleanSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is set of boolean values.
A field with a boolean set value.
BooleanSetFieldBuilder Example to create an instance using the builder pattern
A field with a boolean set value.
interface to build instance of T
 
 
 
 
 
 
Generic type to model the fields that all types of Business Units have in common.
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
BusinessUnitAddAddressActionBuilder Example to create an instance using the builder pattern
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
 
Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.
BusinessUnitAddAssociateActionBuilder Example to create an instance using the builder pattern
Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.
 
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
BusinessUnitAddBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
 
Generated after a successful Add Address update action.
BusinessUnitAddressAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
Generated after a successful Add Address update action.
BusinessUnitAddressAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
 
 
Generated after a successful Change Address update action.
BusinessUnitAddressChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
Generated after a successful Change Address update action.
BusinessUnitAddressChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
 
 
Generated after a successful Remove Address update action.
BusinessUnitAddressRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
Generated after a successful Remove Address update action.
BusinessUnitAddressRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
 
 
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
BusinessUnitAddShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
 
Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message.
BusinessUnitAddStoreActionBuilder Example to create an instance using the builder pattern
Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message.
 
Generated after a successful Add Associate update action.
BusinessUnitAssociateAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Associate update action.
Generated after a successful Add Associate update action.
BusinessUnitAssociateAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Associate update action.
 
 
Generated after a successful Change Associate update action.
BusinessUnitAssociateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Associate update action.
Generated after a successful Change Associate update action.
BusinessUnitAssociateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Associate update action.
 
 
Determines whether a Business Unit can inherit Associates from a parent.
possible values of BusinessUnitAssociateMode
Generated after a successful Change Associate Mode update action.
BusinessUnitAssociateModeChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Associate Mode update action.
Generated after a successful Change Associate Mode update action.
BusinessUnitAssociateModeChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Associate Mode update action.
 
 
Generated after a successful Remove Associate update action.
BusinessUnitAssociateRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Associate update action.
Generated after a successful Remove Associate update action.
BusinessUnitAssociateRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Associate update action.
 
 
Generated after a successful Set Associates update action.
BusinessUnitAssociatesSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Associates update action.
Generated after a successful Set Associates update action.
BusinessUnitAssociatesSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Associates update action.
 
 
Generated after a successful Add Billing Address Identifier update action.
BusinessUnitBillingAddressAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Billing Address Identifier update action.
Generated after a successful Add Billing Address Identifier update action.
BusinessUnitBillingAddressAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Billing Address Identifier update action.
 
 
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBillingAddressRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Billing Address Identifier update action.
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBillingAddressRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Billing Address Identifier update action.
 
 
BusinessUnitBuilder
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
BusinessUnitChangeAddressActionBuilder Example to create an instance using the builder pattern
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
 
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
BusinessUnitChangeAssociateActionBuilder Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
 
Only Business Units of type Division can be changed to ExplicitAndFromParent.
BusinessUnitChangeAssociateModeActionBuilder Example to create an instance using the builder pattern
Only Business Units of type Division can be changed to ExplicitAndFromParent.
 
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
BusinessUnitChangeNameActionBuilder Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
 
Changing the parent of a Business Unit generates a BusinessUnitParentUnitChanged Message.
BusinessUnitChangeParentUnitActionBuilder Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentUnitChanged Message.
 
Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.
BusinessUnitChangeStatusActionBuilder Example to create an instance using the builder pattern
Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.
 
BusinessUnitConfiguration Example to create an instance using the builder pattern
BusinessUnitConfigurationBuilder Example to create an instance using the builder pattern
BusinessUnitConfiguration
 
Default value for Business Unit Status configured though Project settings.
possible values of BusinessUnitConfigurationStatus
Generated after a successful Set Contact Email update action.
BusinessUnitContactEmailSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Contact Email update action.
Generated after a successful Set Contact Email update action.
BusinessUnitContactEmailSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Contact Email update action.
 
 
Generated after a successful Create Business Unit request.
BusinessUnitCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Business Unit request.
Generated after a successful Create Business Unit request.
BusinessUnitCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Business Unit request.
 
 
Generated after a successful Set Default Billing Address update action.
BusinessUnitDefaultBillingAddressSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Default Billing Address update action.
Generated after a successful Set Default Billing Address update action.
BusinessUnitDefaultBillingAddressSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Default Billing Address update action.
 
 
Generated after a successful Set Default Shipping Address update action.
BusinessUnitDefaultShippingAddressSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Default Shipping Address update action.
Generated after a successful Set Default Shipping Address update action.
BusinessUnitDefaultShippingAddressSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Default Shipping Address update action.
 
 
Generated after a successful Delete Business Unit request.
BusinessUnitDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Business Unit request.
Generated after a successful Delete Business Unit request.
BusinessUnitDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Business Unit request.
 
 
Generic draft type to model those fields all Business Units have in common.
BusinessUnitDraftBuilder
Generic draft type to model those fields all Business Units have in common.
 
Generic type to model the fields that all types of Business Units have in common.
Reference to a BusinessUnit by its key.
BusinessUnitKeyReferenceBuilder Example to create an instance using the builder pattern
Reference to a BusinessUnit by its key.
 
Generated after a successful Change Name update action.
BusinessUnitNameChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Name update action.
Generated after a successful Change Name update action.
BusinessUnitNameChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Name update action.
 
 
PagedQueryResult with results containing an array of BusinessUnit.
BusinessUnitPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of BusinessUnit.
 
Generated after a successful Change Parent Unit update action.
BusinessUnitParentUnitChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Parent Unit update action.
Generated after a successful Change Parent Unit update action.
BusinessUnitParentUnitChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Parent Unit update action.
 
 
 
Reference to a BusinessUnit.
BusinessUnitReferenceBuilder Example to create an instance using the builder pattern
Reference to a BusinessUnit.
 
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
BusinessUnitRemoveAddressActionBuilder Example to create an instance using the builder pattern
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
 
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
BusinessUnitRemoveAssociateActionBuilder Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
 
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
BusinessUnitRemoveBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
 
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
BusinessUnitRemoveShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
 
Removes a Store from the Business Unit.
BusinessUnitRemoveStoreActionBuilder Example to create an instance using the builder pattern
Removes a Store from the Business Unit.
 
ResourceIdentifier to a BusinessUnit.
BusinessUnitResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a BusinessUnit.
 
BusinessUnitSetAddressCustomFieldAction Example to create an instance using the builder pattern
BusinessUnitSetAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
BusinessUnitSetAddressCustomFieldAction
 
BusinessUnitSetAddressCustomTypeAction Example to create an instance using the builder pattern
BusinessUnitSetAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
BusinessUnitSetAddressCustomTypeAction
 
Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.
BusinessUnitSetAssociatesActionBuilder Example to create an instance using the builder pattern
Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.
 
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
BusinessUnitSetContactEmailActionBuilder Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
 
BusinessUnitSetCustomFieldAction Example to create an instance using the builder pattern
BusinessUnitSetCustomFieldActionBuilder Example to create an instance using the builder pattern
BusinessUnitSetCustomFieldAction
 
BusinessUnitSetCustomTypeAction Example to create an instance using the builder pattern
BusinessUnitSetCustomTypeActionBuilder Example to create an instance using the builder pattern
BusinessUnitSetCustomTypeAction
 
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
BusinessUnitSetDefaultBillingAddressActionBuilder Example to create an instance using the builder pattern
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
 
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
BusinessUnitSetDefaultShippingAddressActionBuilder Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
 
Only Business Units of type Division can be have a store mode of FromParent.
BusinessUnitSetStoreModeActionBuilder Example to create an instance using the builder pattern
Only Business Units of type Division can be have a store mode of FromParent.
 
Sets the Stores of the Business Unit.
BusinessUnitSetStoresActionBuilder Example to create an instance using the builder pattern
Sets the Stores of the Business Unit.
 
Generated after a successful Add Shipping Address Identifier update action.
BusinessUnitShippingAddressAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Shipping Address Identifier update action.
Generated after a successful Add Shipping Address Identifier update action.
BusinessUnitShippingAddressAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Shipping Address Identifier update action.
 
 
Generated after a successful Remove Shipping Address Identifier update action.
BusinessUnitShippingAddressRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Shipping Address Identifier update action.
Generated after a successful Remove Shipping Address Identifier update action.
BusinessUnitShippingAddressRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Shipping Address Identifier update action.
 
 
Indicates whether the Business Unit can be edited and used in Carts, Orders, Quote Requests, or Quotes.
possible values of BusinessUnitStatus
Generated after a successful Change Status update action.
BusinessUnitStatusChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Status update action.
Generated after a successful Change Status update action.
BusinessUnitStatusChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Status update action.
 
 
Generated after a successful Add Store update action.
BusinessUnitStoreAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
Generated after a successful Add Store update action.
BusinessUnitStoreAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
 
 
Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
possible values of BusinessUnitStoreMode
Generated after a successful Set Store Mode update action.
BusinessUnitStoreModeChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Store Mode update action.
Generated after a successful Set Store Mode update action.
BusinessUnitStoreModeChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Store Mode update action.
 
 
BusinessUnitStoreRemovedMessage Example to create an instance using the builder pattern
BusinessUnitStoreRemovedMessageBuilder Example to create an instance using the builder pattern
BusinessUnitStoreRemovedMessage
BusinessUnitStoreRemovedMessagePayload Example to create an instance using the builder pattern
BusinessUnitStoreRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
BusinessUnitStoreRemovedMessagePayload
 
 
Generated after a successful Set Stores update action.
BusinessUnitStoresSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
Generated after a successful Set Stores update action.
BusinessUnitStoresSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
 
 
The type of the Business Unit indicating its position in a hierarchy.
possible values of BusinessUnitType
BusinessUnitUpdate Example to create an instance using the builder pattern
BusinessUnitUpdateAction Example to create a subtype instance using the builder pattern
BusinessUnitUpdateActionBuilder
BusinessUnitUpdateAction
 
BusinessUnitUpdateBuilder Example to create an instance using the builder pattern
BusinessUnitUpdate
 
 
 
 
 
 
 
 
 
 
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
Creates a Cart in the BusinessUnit referenced by businessUnitKey.
Creates a Cart in the BusinessUnit referenced by businessUnitKey.
Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
 
 
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
Creates an Order from a Cart in a BusinessUnit.
Creates an Order from a Cart in a BusinessUnit.
Creates an Order from a Quote in a BusinessUnit.
Creates an Order from a Quote in a BusinessUnit.
 
 
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
Creates a QuoteRequest in a BusinessUnit.
Creates a QuoteRequest in a BusinessUnit.
 
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
 
 
 
 
 
 
 
Deleting an AssociateRole generates the AssociateRoleDeleted Message.
 
Creating a Associate Role generates the AssociateRoleCreated Message.
Creating a Associate Role generates the AssociateRoleCreated Message.
 
 
 
 
 
 
 
 
 
 
The view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.
 
The view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.
 
 
 
 
 
 
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
 
Retrieves the recently modified active Cart of a Customer with CartOrigin Customer.
 
 
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
 
Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has a predicate that does not match the Cart.
Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has a predicate that does not match the Cart.
Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
 
 
 
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
 
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
 
Creates a request for creating new Categories or updating existing ones.
Creates a request for creating new Categories or updating existing ones.
 
 
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
 
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
 
 
 
 
 
 
 
 
 
 
 
 
Deleting a Customer produces the CustomerDeleted Message.
 
Verifying the email of the Customer produces the CustomerEmailVerified Message.
Verifying the email of the Customer produces the CustomerEmailVerified Message.
 
 
 
 
Creates a request for creating new Customers or updating existing ones.
Creates a request for creating new Customers or updating existing ones.
 
 
Deleting a Customer produces the CustomerDeleted Message.
 
Changing the password produces the CustomerPasswordUpdated Message with reset=false.
Changing the password produces the CustomerPasswordUpdated Message with reset=false.
 
Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true.
Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true.
 
 
 
If the anonymousCart field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.
If the anonymousCart field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.
 
 
 
 
 
 
Deprecated.
 
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.
 
Deprecated scope: manage_orders:{projectKey}
Deprecated scope: view_orders:{projectKey}
Deprecated scope: manage_orders:{projectKey}
Deprecated scope: manage_orders:{projectKey}
 
Deprecated scope: view_orders:{projectKey}
 
Deprecated scope: manage_orders:{projectKey}
Deprecated scope: manage_orders:{projectKey}
 
 
 
 
 
 
 
The view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.
Execute a GraphQL query
Execute a GraphQL query
 
Get the current image search config.
Endpoint to update the image search config.
Endpoint to update the image search config.
 
Accepts an image file and returns similar products from product catalogue.
Accepts an image file and returns similar products from product catalogue.
 
Deletes the import container given by the key.
Retrieves the import container given by the key.
Retrieves all ImportOperations of a given ImportContainer key.
 
Retrieves an ImportSummary for the given import container.
 
Updates the import container given by the key.
Updates the import container given by the key.
 
Retrieves all import containers of a given project key.
Creates a new import container.
Creates a new import container.
 
Retrieves the ImportOperation of a given ID.
 
 
The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.
The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.
 
 
 
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, a ResourceNotFound error is returned.
Updates a Cart in the Store specified by storeKey.
Updates a Cart in the Store specified by storeKey.
 
Retrieves the recently modified active Cart of a Customer with CartOrigin Customer.
 
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, a ResourceNotFound error is returned.
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
 
The store field in the created Cart is set to the Store specified by the storeKey path parameter.
The store field in the created Cart is set to the Store specified by the storeKey path parameter.
Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
 
 
 
Deleting a Customer produces the CustomerDeleted Message.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
The customer verifies the email using the token value.
The customer verifies the email using the token value.
 
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
Deleting a Customer produces the CustomerDeleted Message.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
 
Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true.
Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true.
 
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
 
When using this endpoint, if omitted, the Customer stores field is set to the Store specified in the path parameter.
When using this endpoint, if omitted, the Customer stores field is set to the Store specified in the path parameter.
 
 
Authenticates a Customer associated with a Store.
Authenticates a Customer associated with a Store.
 
Retrieves the Customer's most recently modified active Cart in the Store specified by the storeKey path parameter.
 
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
If the Cart exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.
 
The store field in the created Cart is set to the Store specified by the storeKey path parameter.
The store field in the created Cart is set to the Store specified by the storeKey path parameter.
 
This is the last step in the email verification process of a Customer.
This is the last step in the email verification process of a Customer.
 
Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.
Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.
 
 
 
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
 
This is the last step in the password reset process of the authenticated Customer.
This is the last step in the password reset process of the authenticated Customer.
 
 
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
 
 
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
 
When using this endpoint, the store field of a ShoppingList is always set to the Store specified in the path parameter.
When using this endpoint, the store field of a ShoppingList is always set to the Store specified in the path parameter.
 
If omitted in the request body, the Customer stores field is set to the Store specified in the path parameter.
If omitted in the request body, the Customer stores field is set to the Store specified in the path parameter.
 
Returns an order by its ID from a specific Store.
Updates an order in the store specified by {storeKey}.
Updates an order in the store specified by {storeKey}.
 
Queries orders in a specific Store.
Returns an order by its order number from a specific Store.
Updates an order in the store specified by {storeKey}.
Updates an order in the store specified by {storeKey}.
 
Creates an order from a Cart from a specific Store.
Creates an order from a Cart from a specific Store.
 
 
Gets the current or staged representation of a Product by its ID from the specified Store.
 
Gets the current or staged representation of a Product by its key from the specified Store.
 
 
Queries Product Selection assignments over all Product Selections that are active in a specific Store.
 
 
Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store.
 
 
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
 
 
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
If a ShoppingList exists in a Project but does not have the store field, or the store field references a different Store, the ResourceNotFound error is returned.
 
When using this endpoint, the store field of a ShoppingList is always set to the Store specified in the path parameter.
When using this endpoint, the store field of a ShoppingList is always set to the Store specified in the path parameter.
 
 
Creates a request for creating new Inventories or updating existing ones.
Creates a request for creating new Inventories or updating existing ones.
 
 
 
Produces the InventoryEntryDeleted Message.
 
 
Produces the InventoryEntryDeleted Message.
 
Produces the InventoryEntryCreated Message.
Produces the InventoryEntryCreated Message.
 
 
Authenticates a global Customer not associated with a Store.
Authenticates a global Customer not associated with a Store.
 
Retrieves the Customer's most recently modified active Cart.
 
 
 
Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.
Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.
 
 
 
Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.
Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.
 
 
This is the last step in the email verification process of a Customer.
This is the last step in the email verification process of a Customer.
 
Retrieves the authenticated customer (that matches the given email/password pair).
Retrieves the authenticated customer (that matches the given email/password pair).
 
 
 
 
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
Changing the password of the Customer produces the CustomerPasswordUpdated Message with reset=false.
 
This is the last step in the password reset process of a Customer.
This is the last step in the password reset process of a Customer.
 
This endpoint can only delete a Payment when it has no Transactions.
This endpoint can only update a Payment when it has no Transactions.
This endpoint can only update a Payment when it has no Transactions.
 
This endpoint can only delete a Payment when it has no Transactions.
This endpoint can only update a Payment when it has no Transactions.
This endpoint can only update a Payment when it has no Transactions.
 
Creating a Payment produces the PaymentCreated Message.
Creating a Payment produces the PaymentCreated Message.
 
 
 
 
 
 
 
 
 
 
 
If used with an access token for an anonymous session, all Orders and Carts that belong to the anonymousId are assigned to the newly created Customer.
If used with an access token for an anonymous session, all Orders and Carts that belong to the anonymousId are assigned to the newly created Customer.
 
Deprecated scope: view_orders:{projectKey}
 
Deprecated scope: view_orders:{projectKey}
 
 
Creates a new import request for order patches
Creates a new import request for order patches
 
 
 
 
 
 
 
 
 
 
Creates a request for creating new Orders.
Creates a request for creating new Orders.
 
 
Create an Order by Import
Create an Order by Import
 
In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, it should be provided in URL-encoded format.
 
Creates an order from a Cart.
Creates an order from a Cart.
Create an Order from a Quote
Create an Order from a Quote
 
 
 
 
Checks whether a search index for the Project's Orders exists.
 
 
 
 
Creating a Payment produces the PaymentCreated Message.
Creating a Payment produces the PaymentCreated Message.
 
 
Creates a request for creating new Prices or updating existing ones.
Creates a request for creating new Prices or updating existing ones.
 
 
 
 
 
 
This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.
This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.
 
 
 
Creates a request for creating new ProductDrafts or updating existing ones.
Creates a request for creating new ProductDrafts or updating existing ones.
 
 
 
Gets the current or staged representation of a Product by its ID.
 
Use the Product Projections query endpoint to get the current or staged representations of Products.
 
Gets the current or staged representation of a Product found by Key.
 
 
Product Projection Search
Product Projection Search
 
 
 
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
Check if a Product exists with a specified id.
Upload a JPEG, PNG and GIF file to a ProductVariant.
Upload a JPEG, PNG and GIF file to a ProductVariant.
 
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
 
 
Deletion will only succeed if the Product Selection is not assigned to any Store.
 
 
 
Deletion will only succeed if the Product Selection is not assigned to any Store.
 
 
 
 
If Price selection query parameters are provided, the selected Prices are added to the response.
 
Check if Products exist.
Creates a request for creating new Products or updating existing ones.
Creates a request for creating new Products or updating existing ones.
 
 
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
Check if a Product exists with a specified key.
A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.
A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.
 
 
To create a new Product, send a representation that is going to become the initial staged representation of the new Product in the master catalog.
To create a new Product, send a representation that is going to become the initial staged representation of the new Product in the master catalog.
 
 
 
Checks if a Product Type with given id exists.
 
 
Check if Product Types exist.
Creates a request for creating new ProductTypes or updating existing ones.
Creates a request for creating new ProductTypes or updating existing ones.
 
 
Checks if a Product Type with given key exists.
 
 
 
 
Creates a new import request for product variant patches
Creates a new import request for product variant patches
 
 
 
Creates a request for creating new ProductVariants or updating existing ones.
Creates a request for creating new ProductVariants or updating existing ones.
 
 
 
 
 
 
 
 
 
 
 
This endpoint takes arbitrary product names or image URLs and generates recommendations from a general set of categories, which cover a broad range of industries.
 
Response Representation: PagedQueryResult with a results array of ProjectCategoryrecommendation, sorted by confidence scores in descending order and the meta information of ProjectCategoryrecommendationMeta.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart.
Retrieves all the ShippingMethods that can ship to the given Location with a predicate that matches the given Cart.
 
 
Retrieves all the ShippingMethods that can ship to the given Location.
 
Retrieves all the ShippingMethods that can ship to the given Location for an OrderEdit.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Produces the StandalonePriceDeleted Message.
 
 
Creates a request for creating new Standalone Prices or updating existing ones.
Creates a request for creating new Standalone Prices or updating existing ones.
 
 
Produces the StandalonePriceDeleted Message.
 
Produces the StandalonePriceCreated Message.
Produces the StandalonePriceCreated Message.
 
 
 
 
 
 
 
 
 
 
 
 
 
This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions.
 
 
 
 
A test message is sent to ensure the correct configuration of the Destination.
A test message is sent to ensure the correct configuration of the Destination.
 
 
 
 
 
 
 
 
 
Creates a request for creating new Type or updating existing ones.
Creates a request for creating new Type or updating existing ones.
 
 
 
 
 
 
 
 
 
 
 
 
Cart Example to create an instance using the builder pattern
If the Cart already contains a CustomLineItem with the same slug, name, money, taxCategory, state, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.
CartAddCustomLineItemActionBuilder Example to create an instance using the builder pattern
If the Cart already contains a CustomLineItem with the same slug, name, money, taxCategory, state, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.
 
To add a custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) to the Cart, it must have the Multiple ShippingMode.
CartAddCustomShippingMethodActionBuilder Example to create an instance using the builder pattern
To add a custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) to the Cart, it must have the Multiple ShippingMode.
 
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
CartAddDiscountCodeActionBuilder Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
 
Adds an address to a Cart when shipping to multiple addresses is desired.
CartAddItemShippingAddressActionBuilder Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
 
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
CartAddLineItemActionBuilder Example to create an instance using the builder pattern
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
 
CartAddPaymentAction Example to create an instance using the builder pattern
CartAddPaymentActionBuilder Example to create an instance using the builder pattern
CartAddPaymentAction
 
Adds a Shipping Method for a specified shipping address to a Cart with Multiple ShippingMode.
CartAddShippingMethodActionBuilder Example to create an instance using the builder pattern
Adds a Shipping Method for a specified shipping address to a Cart with Multiple ShippingMode.
 
Adds all LineItems of a ShoppingList to the Cart.
CartAddShoppingListActionBuilder Example to create an instance using the builder pattern
Adds all LineItems of a ShoppingList to the Cart.
 
CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction
 
To override the shipping details, see Set LineItemShippingDetails.
CartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder pattern
To override the shipping details, see Set LineItemShippingDetails.
 
CartBuilder Example to create an instance using the builder pattern
CartChangeCustomLineItemMoneyAction Example to create an instance using the builder pattern
CartChangeCustomLineItemMoneyActionBuilder Example to create an instance using the builder pattern
CartChangeCustomLineItemMoneyAction
 
CartChangeCustomLineItemPriceModeAction Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeActionBuilder Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeAction
 
When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
CartChangeCustomLineItemQuantityActionBuilder Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
 
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
CartChangeLineItemQuantityActionBuilder Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
 
Changing the tax calculation mode leads to recalculation of taxes.
CartChangeTaxCalculationModeActionBuilder Example to create an instance using the builder pattern
Changing the tax calculation mode leads to recalculation of taxes.
 
When External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed. When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress. Example to create an instance using the builder pattern
CartChangeTaxModeActionBuilder Example to create an instance using the builder pattern
When External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed. When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress.
 
Changing the tax rounding mode leads to recalculation of taxes.
CartChangeTaxRoundingModeActionBuilder Example to create an instance using the builder pattern
Changing the tax rounding mode leads to recalculation of taxes.
 
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, Light, Medium, or Heavy).
CartClassificationTier Example to create an instance using the builder pattern
CartClassificationTierBuilder Example to create an instance using the builder pattern
CartClassificationTierBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, Light, Medium, or Heavy).
CartClassificationTier
 
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, Light, Medium, or Heavy).
CartClassificationTypeBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, Light, Medium, or Heavy).
 
CartDiscount Example to create an instance using the builder pattern
CartDiscountBuilder Example to create an instance using the builder pattern
CartDiscountChangeCartPredicateAction Example to create an instance using the builder pattern
CartDiscountChangeCartPredicateActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeCartPredicateAction
 
CartDiscountChangeIsActiveAction Example to create an instance using the builder pattern
CartDiscountChangeIsActiveActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeIsActiveAction
 
CartDiscountChangeNameAction Example to create an instance using the builder pattern
CartDiscountChangeNameActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeNameAction
 
CartDiscountChangeRequiresDiscountCodeAction Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeAction
 
CartDiscountChangeSortOrderAction Example to create an instance using the builder pattern
CartDiscountChangeSortOrderActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeSortOrderAction
 
CartDiscountChangeStackingModeAction Example to create an instance using the builder pattern
CartDiscountChangeStackingModeActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeStackingModeAction
 
CartDiscountChangeTargetAction Example to create an instance using the builder pattern
CartDiscountChangeTargetActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeTargetAction
 
CartDiscountChangeValueAction Example to create an instance using the builder pattern
CartDiscountChangeValueActionBuilder Example to create an instance using the builder pattern
CartDiscountChangeValueAction
 
Discount is applied to CustomLineItems matching the predicate.
CartDiscountCustomLineItemsTargetBuilder Example to create an instance using the builder pattern
Discount is applied to CustomLineItems matching the predicate.
 
CartDiscountDraft Example to create an instance using the builder pattern
CartDiscountDraftBuilder Example to create an instance using the builder pattern
CartDiscountDraft
 
CartDiscount
References a cart discount by key.
CartDiscountKeyReferenceBuilder Example to create an instance using the builder pattern
References a cart discount by key.
Discount is applied to LineItems matching the predicate.
CartDiscountLineItemsTargetBuilder Example to create an instance using the builder pattern
Discount is applied to LineItems matching the predicate.
 
 
PagedQueryResult with results containing an array of CartDiscount.
CartDiscountPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of CartDiscount.
 
 
Reference to a CartDiscount.
CartDiscountReferenceBuilder Example to create an instance using the builder pattern
Reference to a CartDiscount.
 
ResourceIdentifier to a CartDiscount.
CartDiscountResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a CartDiscount.
 
CartDiscountSetCustomFieldAction Example to create an instance using the builder pattern
CartDiscountSetCustomFieldActionBuilder Example to create an instance using the builder pattern
CartDiscountSetCustomFieldAction
 
CartDiscountSetCustomTypeAction Example to create an instance using the builder pattern
CartDiscountSetCustomTypeActionBuilder Example to create an instance using the builder pattern
CartDiscountSetCustomTypeAction
 
CartDiscountSetDescriptionAction Example to create an instance using the builder pattern
CartDiscountSetDescriptionActionBuilder Example to create an instance using the builder pattern
CartDiscountSetDescriptionAction
 
CartDiscountSetKeyAction Example to create an instance using the builder pattern
CartDiscountSetKeyActionBuilder Example to create an instance using the builder pattern
CartDiscountSetKeyAction
 
CartDiscountSetValidFromAction Example to create an instance using the builder pattern
CartDiscountSetValidFromActionBuilder Example to create an instance using the builder pattern
CartDiscountSetValidFromAction
 
CartDiscountSetValidFromAndUntilAction Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilActionBuilder Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilAction
 
CartDiscountSetValidUntilAction Example to create an instance using the builder pattern
CartDiscountSetValidUntilActionBuilder Example to create an instance using the builder pattern
CartDiscountSetValidUntilAction
 
Discount is applied to the shipping costs of the Cart.
CartDiscountShippingCostTargetBuilder Example to create an instance using the builder pattern
Discount is applied to the shipping costs of the Cart.
 
CartDiscountTarget Example to create a subtype instance using the builder pattern
CartDiscountTargetBuilder
CartDiscountTarget
 
CartDiscountUpdate Example to create an instance using the builder pattern
CartDiscountUpdateAction Example to create a subtype instance using the builder pattern
CartDiscountUpdateActionBuilder
CartDiscountUpdateAction
 
CartDiscountUpdateBuilder Example to create an instance using the builder pattern
CartDiscountUpdate
 
CartDiscountValue Example to create a subtype instance using the builder pattern
Discounts the CartDiscountTarget by an absolute amount (not allowed for MultiBuyLineItemsTarget and MultiBuyCustomLineItemsTarget).
CartDiscountValueAbsoluteBuilder Example to create an instance using the builder pattern
CartDiscountValueAbsoluteDraft Example to create an instance using the builder pattern
CartDiscountValueAbsoluteDraftBuilder Example to create an instance using the builder pattern
CartDiscountValueAbsoluteDraft
 
Discounts the CartDiscountTarget by an absolute amount (not allowed for MultiBuyLineItemsTarget and MultiBuyCustomLineItemsTarget).
 
CartDiscountValueBuilder
CartDiscountValueDraft Example to create a subtype instance using the builder pattern
CartDiscountValueDraftBuilder
CartDiscountValueDraft
 
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the money field, if it is lower than the current Line Item price for the same currency.
CartDiscountValueFixedBuilder Example to create an instance using the builder pattern
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the money field, if it is lower than the current Line Item price for the same currency.
CartDiscountValueFixedDraftBuilder Example to create an instance using the builder pattern
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the money field, if it is lower than the current Line Item price for the same currency.
 
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the money field, if it is lower than the current Line Item price for the same currency.
 
CartDiscountValueGiftLineItem Example to create an instance using the builder pattern
CartDiscountValueGiftLineItemBuilder Example to create an instance using the builder pattern
CartDiscountValueGiftLineItemDraft Example to create an instance using the builder pattern
CartDiscountValueGiftLineItemDraftBuilder Example to create an instance using the builder pattern
CartDiscountValueGiftLineItemDraft
 
CartDiscountValueGiftLineItem
 
CartDiscountValue
 
Discounts the CartDiscountTarget relative to its price.
CartDiscountValueRelativeBuilder Example to create an instance using the builder pattern
CartDiscountValueRelativeDraft Example to create an instance using the builder pattern
CartDiscountValueRelativeDraftBuilder Example to create an instance using the builder pattern
CartDiscountValueRelativeDraft
 
Discounts the CartDiscountTarget relative to its price.
 
CartDraft Example to create an instance using the builder pattern
CartDraftBuilder Example to create an instance using the builder pattern
CartDraft
 
Changes the CartState from Active to Frozen.
CartFreezeCartActionBuilder Example to create an instance using the builder pattern
Changes the CartState from Active to Frozen.
 
Cart
References a cart by key.
CartKeyReferenceBuilder Example to create an instance using the builder pattern
References a cart by key.
 
Indicates who created the Cart.
Maps to Order.origin.
possible values of CartOrigin
possible values of CartOrigin
PagedQueryResult with results containing an array of Cart.
CartPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Cart.
 
 
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
CartRecalculateActionBuilder Example to create an instance using the builder pattern
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
 
Reference to a Cart.
CartReferenceBuilder Example to create an instance using the builder pattern
Reference to a Cart.
 
This update action does not support specifying quantities, unlike the Remove LineItem update action.
CartRemoveCustomLineItemActionBuilder Example to create an instance using the builder pattern
This update action does not support specifying quantities, unlike the Remove LineItem update action.
 
CartRemoveDiscountCodeAction Example to create an instance using the builder pattern
CartRemoveDiscountCodeActionBuilder Example to create an instance using the builder pattern
CartRemoveDiscountCodeAction
 
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
CartRemoveItemShippingAddressActionBuilder Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
 
The LineItem price is updated as described in LineItem Price selection.
CartRemoveLineItemActionBuilder Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
 
CartRemovePaymentAction Example to create an instance using the builder pattern
CartRemovePaymentActionBuilder Example to create an instance using the builder pattern
CartRemovePaymentAction
 
Removes a Shipping Method from a Cart that has the Multiple ShippingMode.
CartRemoveShippingMethodActionBuilder Example to create an instance using the builder pattern
Removes a Shipping Method from a Cart that has the Multiple ShippingMode.
 
ResourceIdentifier to a Cart.
CartResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Cart.
 
CartsConfiguration Example to create an instance using the builder pattern
CartsConfigurationBuilder Example to create an instance using the builder pattern
CartsConfiguration
 
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
CartScoreTierBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
 
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
CartScoreTypeBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
 
CartSetAnonymousIdAction Example to create an instance using the builder pattern
CartSetAnonymousIdActionBuilder Example to create an instance using the builder pattern
CartSetAnonymousIdAction
 
CartSetBillingAddressAction Example to create an instance using the builder pattern
CartSetBillingAddressActionBuilder Example to create an instance using the builder pattern
CartSetBillingAddressAction
 
CartSetBillingAddressCustomFieldAction Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldAction
 
CartSetBillingAddressCustomTypeAction Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeAction
 
Updates the Business Unit on the Cart.
CartSetBusinessUnitActionBuilder Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
 
This update action results in the taxedPrice field being added to the Cart when the ExternalAmount TaxMode is used.
CartSetCartTotalTaxActionBuilder Example to create an instance using the builder pattern
This update action results in the taxedPrice field being added to the Cart when the ExternalAmount TaxMode is used.
 
Setting the country can lead to changes in the LineItem prices.
CartSetCountryActionBuilder Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
 
CartSetCustomerEmailAction Example to create an instance using the builder pattern
CartSetCustomerEmailActionBuilder Example to create an instance using the builder pattern
CartSetCustomerEmailAction
 
This update action can only be used if a Customer is not assigned to a Cart.
CartSetCustomerGroupActionBuilder Example to create an instance using the builder pattern
This update action can only be used if a Customer is not assigned to a Cart.
 
Setting the Cart's customerId can lead to updates on all its LineItem prices.
CartSetCustomerIdActionBuilder Example to create an instance using the builder pattern
Setting the Cart's customerId can lead to updates on all its LineItem prices.
 
CartSetCustomFieldAction Example to create an instance using the builder pattern
CartSetCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetCustomFieldAction
 
CartSetCustomLineItemCustomFieldAction Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldAction
 
CartSetCustomLineItemCustomTypeAction Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeAction
 
CartSetCustomLineItemShippingDetailsAction Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsAction
 
Can be used if the Cart has the ExternalAmount TaxMode.
CartSetCustomLineItemTaxAmountActionBuilder Example to create an instance using the builder pattern
Can be used if the Cart has the ExternalAmount TaxMode.
 
Can be used if the Cart has the External TaxMode.
CartSetCustomLineItemTaxRateActionBuilder Example to create an instance using the builder pattern
Can be used if the Cart has the External TaxMode.
 
To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the Single ShippingMode and a shippingAddress.
CartSetCustomShippingMethodActionBuilder Example to create an instance using the builder pattern
To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the Single ShippingMode and a shippingAddress.
 
CartSetCustomTypeAction Example to create an instance using the builder pattern
CartSetCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetCustomTypeAction
 
Number of days after which a Cart with Active CartState is deleted since its last modification.
CartSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder pattern
Number of days after which a Cart with Active CartState is deleted since its last modification.
 
CartSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern
CartSetDeliveryAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetDeliveryAddressCustomFieldAction
 
CartSetDeliveryAddressCustomTypeAction Example to create an instance using the builder pattern
CartSetDeliveryAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetDeliveryAddressCustomTypeAction
 
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
CartSetDirectDiscountsActionBuilder Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
 
CartSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldAction
 
CartSetItemShippingAddressCustomTypeAction Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeAction
 
CartSetKeyAction Example to create an instance using the builder pattern
CartSetKeyActionBuilder Example to create an instance using the builder pattern
CartSetKeyAction
 
CartSetLineItemCustomFieldAction Example to create an instance using the builder pattern
CartSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetLineItemCustomFieldAction
 
CartSetLineItemCustomTypeAction Example to create an instance using the builder pattern
CartSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetLineItemCustomTypeAction
 
Setting a distribution channel for a LineItem can lead to an updated price as described in LineItem Price selection.
CartSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder pattern
Setting a distribution channel for a LineItem can lead to an updated price as described in LineItem Price selection.
 
CartSetLineItemInventoryModeAction Example to create an instance using the builder pattern
CartSetLineItemInventoryModeActionBuilder Example to create an instance using the builder pattern
CartSetLineItemInventoryModeAction
 
Sets the LineItem price and changes the priceMode to ExternalPrice LineItemPriceMode.
CartSetLineItemPriceActionBuilder Example to create an instance using the builder pattern
Sets the LineItem price and changes the priceMode to ExternalPrice LineItemPriceMode.
 
CartSetLineItemShippingDetailsAction Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsAction
 
Performing this action has no impact on inventory that should be reserved.
CartSetLineItemSupplyChannelActionBuilder Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
 
Can be used if the Cart has the ExternalAmount TaxMode.
CartSetLineItemTaxAmountActionBuilder Example to create an instance using the builder pattern
Can be used if the Cart has the ExternalAmount TaxMode.
 
Can be used if the Cart has the External TaxMode.
CartSetLineItemTaxRateActionBuilder Example to create an instance using the builder pattern
Can be used if the Cart has the External TaxMode.
 
Sets the LineItem totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.
CartSetLineItemTotalPriceActionBuilder Example to create an instance using the builder pattern
Sets the LineItem totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.
 
CartSetLocaleAction Example to create an instance using the builder pattern
CartSetLocaleActionBuilder Example to create an instance using the builder pattern
CartSetLocaleAction
 
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
CartSetShippingAddressActionBuilder Example to create an instance using the builder pattern
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
 
CartSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldAction
 
CartSetShippingAddressCustomTypeAction Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeAction
 
CartSetShippingCustomFieldAction Example to create an instance using the builder pattern
CartSetShippingCustomFieldActionBuilder Example to create an instance using the builder pattern
CartSetShippingCustomFieldAction
 
This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's shippingMethod or shipping.
CartSetShippingCustomTypeActionBuilder Example to create an instance using the builder pattern
This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's shippingMethod or shipping.
 
To set the Cart's Shipping Method the Cart must have the Single ShippingMode and a shippingAddress.
CartSetShippingMethodActionBuilder Example to create an instance using the builder pattern
To set the Cart's Shipping Method the Cart must have the Single ShippingMode and a shippingAddress.
 
A Shipping Method tax amount can be set if the Cart has the ExternalAmount TaxMode.
CartSetShippingMethodTaxAmountActionBuilder Example to create an instance using the builder pattern
A Shipping Method tax amount can be set if the Cart has the ExternalAmount TaxMode.
 
A Shipping Method Tax Rate can be set if the Cart has the External TaxMode.
CartSetShippingMethodTaxRateActionBuilder Example to create an instance using the builder pattern
A Shipping Method Tax Rate can be set if the Cart has the External TaxMode.
 
Input used to select a ShippingRatePriceTier.
CartSetShippingRateInputActionBuilder Example to create an instance using the builder pattern
Input used to select a ShippingRatePriceTier.
 
Indicates the current status of a Cart.
possible values of CartState
Changes the CartState from Frozen to Active.
CartUnfreezeCartActionBuilder Example to create an instance using the builder pattern
Changes the CartState from Frozen to Active.
 
CartUpdate Example to create an instance using the builder pattern
CartUpdateAction Example to create a subtype instance using the builder pattern
CartUpdateActionBuilder
CartUpdateAction
 
CartUpdateBuilder Example to create an instance using the builder pattern
CartUpdate
Updates an address in itemShippingAddresses by keeping the Address key.
CartUpdateItemShippingAddressActionBuilder Example to create an instance using the builder pattern
Updates an address in itemShippingAddresses by keeping the Address key.
 
 
Used when the ShippingRate maps to the sum of LineItem Prices.
CartValueTierBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to the sum of LineItem Prices.
 
Used when the ShippingRate maps to the sum of LineItem Prices.
CartValueTypeBuilder Example to create an instance using the builder pattern
Used when the ShippingRate maps to the sum of LineItem Prices.
 
Category Example to create an instance using the builder pattern
CategoryAddAssetAction Example to create an instance using the builder pattern
CategoryAddAssetActionBuilder Example to create an instance using the builder pattern
CategoryAddAssetAction
 
CategoryBuilder Example to create an instance using the builder pattern
CategoryChangeAssetNameAction Example to create an instance using the builder pattern
CategoryChangeAssetNameActionBuilder Example to create an instance using the builder pattern
CategoryChangeAssetNameAction
 
This update action changes the order of the assets array.
CategoryChangeAssetOrderActionBuilder Example to create an instance using the builder pattern
This update action changes the order of the assets array.
 
CategoryChangeNameAction Example to create an instance using the builder pattern
CategoryChangeNameActionBuilder Example to create an instance using the builder pattern
CategoryChangeNameAction
 
CategoryChangeOrderHintAction Example to create an instance using the builder pattern
CategoryChangeOrderHintActionBuilder Example to create an instance using the builder pattern
CategoryChangeOrderHintAction
 
CategoryChangeParentAction Example to create an instance using the builder pattern
CategoryChangeParentActionBuilder Example to create an instance using the builder pattern
CategoryChangeParentAction
 
Changing the slug produces the CategorySlugChanged Message.
CategoryChangeSlugActionBuilder Example to create an instance using the builder pattern
Changing the slug produces the CategorySlugChanged Message.
 
Generated after a successful Create Category request.
CategoryCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Category request.
Generated after a successful Create Category request.
CategoryCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Category request.
 
 
CategoryDraft Example to create an instance using the builder pattern
CategoryDraftBuilder Example to create an instance using the builder pattern
CategoryDraft
 
Category
The data representation for a Category to be imported that is persisted as a Category in the Project.
CategoryImportBuilder Example to create an instance using the builder pattern
The data representation for a Category to be imported that is persisted as a Category in the Project.
The request body to import Categories.
CategoryImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Categories.
References a category by key.
CategoryKeyReferenceBuilder Example to create an instance using the builder pattern
References a category by key.
 
JSON object where the key is a Category id and the value is an order hint.
CategoryOrderHints Example to create an instance using the builder pattern
CategoryOrderHintsBuilder Example to create an instance using the builder pattern
CategoryOrderHintsBuilder Example to create an instance using the builder pattern
JSON object where the key is a Category id and the value is an order hint.
CategoryOrderHints
 
PagedQueryResult with results containing an array of Category.
CategoryPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Category.
 
 
Reference to a Category.
CategoryReference Example to create an instance using the builder pattern
CategoryReferenceBuilder Example to create an instance using the builder pattern
CategoryReferenceBuilder Example to create an instance using the builder pattern
Reference to a Category.
CategoryReference
 
CategoryRemoveAssetAction Example to create an instance using the builder pattern
CategoryRemoveAssetActionBuilder Example to create an instance using the builder pattern
CategoryRemoveAssetAction
 
ResourceIdentifier to a Category.
CategoryResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Category.
 
CategorySetAssetCustomFieldAction Example to create an instance using the builder pattern
CategorySetAssetCustomFieldActionBuilder Example to create an instance using the builder pattern
CategorySetAssetCustomFieldAction
 
CategorySetAssetCustomTypeAction Example to create an instance using the builder pattern
CategorySetAssetCustomTypeActionBuilder Example to create an instance using the builder pattern
CategorySetAssetCustomTypeAction
 
CategorySetAssetDescriptionAction Example to create an instance using the builder pattern
CategorySetAssetDescriptionActionBuilder Example to create an instance using the builder pattern
CategorySetAssetDescriptionAction
 
Set or remove the key of an Asset.
CategorySetAssetKeyActionBuilder Example to create an instance using the builder pattern
Set or remove the key of an Asset.
 
CategorySetAssetSourcesAction Example to create an instance using the builder pattern
CategorySetAssetSourcesActionBuilder Example to create an instance using the builder pattern
CategorySetAssetSourcesAction
 
CategorySetAssetTagsAction Example to create an instance using the builder pattern
CategorySetAssetTagsActionBuilder Example to create an instance using the builder pattern
CategorySetAssetTagsAction
 
CategorySetCustomFieldAction Example to create an instance using the builder pattern
CategorySetCustomFieldActionBuilder Example to create an instance using the builder pattern
CategorySetCustomFieldAction
 
CategorySetCustomTypeAction Example to create an instance using the builder pattern
CategorySetCustomTypeActionBuilder Example to create an instance using the builder pattern
CategorySetCustomTypeAction
 
CategorySetDescriptionAction Example to create an instance using the builder pattern
CategorySetDescriptionActionBuilder Example to create an instance using the builder pattern
CategorySetDescriptionAction
 
This update action sets a new ID that can be used as an additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
CategorySetExternalIdActionBuilder Example to create an instance using the builder pattern
This update action sets a new ID that can be used as an additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
 
CategorySetKeyAction Example to create an instance using the builder pattern
CategorySetKeyActionBuilder Example to create an instance using the builder pattern
CategorySetKeyAction
 
CategorySetMetaDescriptionAction Example to create an instance using the builder pattern
CategorySetMetaDescriptionActionBuilder Example to create an instance using the builder pattern
CategorySetMetaDescriptionAction
 
CategorySetMetaKeywordsAction Example to create an instance using the builder pattern
CategorySetMetaKeywordsActionBuilder Example to create an instance using the builder pattern
CategorySetMetaKeywordsAction
 
CategorySetMetaTitleAction Example to create an instance using the builder pattern
CategorySetMetaTitleActionBuilder Example to create an instance using the builder pattern
CategorySetMetaTitleAction
 
Generated after a successful Change Slug update action.
CategorySlugChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
Generated after a successful Change Slug update action.
CategorySlugChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
 
 
All categories in the project, represented as an in-memory tree.
Helper to create a Tree structure from a list of categories
CategoryUpdate Example to create an instance using the builder pattern
CategoryUpdateAction Example to create a subtype instance using the builder pattern
CategoryUpdateActionBuilder
CategoryUpdateAction
 
CategoryUpdateBuilder Example to create an instance using the builder pattern
CategoryUpdate
 
Object that stores cent amounts in a specific currency.
CentPrecisionMoneyBuilder Example to create an instance using the builder pattern
This draft type is the alternative to Money.
CentPrecisionMoneyDraftBuilder Example to create an instance using the builder pattern
This draft type is the alternative to Money.
 
Object that stores cent amounts in a specific currency.
 
Difference between the previous and next version of a resource represented by previousValue (omitted, for example, on creations) and nextValue of the associated change.
Change triggered by the Change Address update action.
ChangeAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Address update action.
Change triggered automatically due to a user-initiated change.
ChangeAmountAuthorizedChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
Change triggered by the Change AmountPlanned update action.
ChangeAmountPlannedChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change AmountPlanned update action.
Change triggered by the following update actions:
ChangeAssetNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeAssetOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change AttributeDefinition AttributeConstraint update action.
ChangeAttributeConstraintChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change AttributeDefinition AttributeConstraint update action.
Change triggered by the Change the order of AttributeDefinitions update action.
ChangeAttributeOrderByNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change the order of AttributeDefinitions update action.
ChangeBuilder
Change triggered by the Change CartDiscounts update action.
ChangeCartDiscountsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change CartDiscounts update action.
Change triggered by the Change Cart Predicate update action.
ChangeCartPredicateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Cart Predicate update action.
Change triggered by the Change CustomLineItem Quantity update action.
ChangeCustomLineItemQuantityChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change CustomLineItem Quantity update action.
Change triggered by the following update actions:
ChangeDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change Email update action.
ChangeEmailChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Email update action.
Change triggered by the Change EnumValue Label update action.
ChangeEnumValueLabelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change EnumValue Label update action.
Change triggered by the Change the order of EnumValues update action.
ChangeEnumValueOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change the order of EnumValues update action.
Change triggered by the Change the order of FieldDefinitions update action.
ChangeFieldDefinitionOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change the order of FieldDefinitions update action.
Change triggered by the Change Groups update action.
ChangeGroupsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Groups update action.
This data type represents the supported resource types.
possible values of ChangeHistoryResourceType
Difference between the previous and next version of a resource represented by previousValue (omitted, for example, on creations) and nextValue of the associated change.
Change triggered by the Change initial State update action.
ChangeInitialChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change initial State update action.
Change triggered by the following update actions:
ChangeInputHintChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeIsActiveChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change AttributeDefinition IsSearchable update action.
ChangeIsSearchableChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change AttributeDefinition IsSearchable update action.
Change triggered by the following update actions:
ChangeKeyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeLabelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change LineItem Quantity update action.
ChangeLineItemQuantityChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change LineItem Quantity update action.
Change triggered by the following update actions:
ChangeLocalizedDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeLocalizedEnumValueLabelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeLocalizedEnumValueOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeLocalizedNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change Master Variant update action.
ChangeMasterVariantChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Master Variant update action.
Change triggered by the following update actions:
ChangeNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change OrderHint update action.
ChangeOrderHintChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change OrderHint update action.
Change triggered by the following update actions:
ChangeOrderStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change Parent update action.
ChangeParentChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Parent update action.
Change triggered by the following update actions:
ChangePaymentStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change the label of an EnumValue update action.
ChangePlainEnumValueLabelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change the label of an EnumValue update action.
Change triggered by the Change the order of EnumValues update action.
ChangePlainEnumValueOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change the order of EnumValues update action.
Change triggered by the Change Predicate update action.
ChangePredicateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Predicate update action.
Change triggered by the Change Price update action.
ChangePriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Price update action.
Change triggered by the Change Quantity update action.
ChangeQuantityChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Quantity update action.
Change triggered by the Change Quote Request State update action.
ChangeQuoteRequestStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Quote Request State update action.
Change triggered by the Change Quote State update action.
ChangeQuoteStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Quote State update action.
Change triggered by the Change Requires DiscountCode update action.
ChangeRequiresDiscountCodeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Requires DiscountCode update action.
ChangeReviewRatingStatisticsChange Example to create an instance using the builder pattern
ChangeReviewRatingStatisticsChangeBuilder Example to create an instance using the builder pattern
ChangeReviewRatingStatisticsChange
Change triggered by the following update actions:
ChangeShipmentStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change ShoppingListLineItem Quantity update action.
ChangeShoppingListLineItemQuantityChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change ShoppingListLineItem Quantity update action.
Change triggered by the Change ShoppingListLineItems Order update action.
ChangeShoppingListLineItemsOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change ShoppingListLineItems Order update action.
Change triggered by the following update actions:
ChangeSlugChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
ChangeSortOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Change Stacking Mode update action.
ChangeStackingModeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Stacking Mode update action.
Change triggered by the ChangeStagedQuoteState update action.
ChangeStagedQuoteStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the ChangeStagedQuoteState update action.
Change triggered by the Change State Type update action.
ChangeStateTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change State Type update action.
ChangeStatusUpdateAction Example to create an instance using the builder pattern
ChangeStatusUpdateActionBuilder Example to create an instance using the builder pattern
ChangeStatusUpdateAction
Notification about changes to a resource.
ChangeSubscriptionBuilder Example to create an instance using the builder pattern
Notification about changes to a resource.
 
Resource types supported by ChangeSubscriptions:
possible values of ChangeSubscriptionResourceTypeId
Change triggered by the Change Target update action.
ChangeTargetChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Target update action.
ChangeTargetChangeValue Example to create a subtype instance using the builder pattern
ChangeTargetChangeValueBuilder
ChangeTargetChangeValue
ChangeTargetCustomLineItemsChangeValue Example to create an instance using the builder pattern
ChangeTargetCustomLineItemsChangeValueBuilder Example to create an instance using the builder pattern
ChangeTargetCustomLineItemsChangeValue
ChangeTargetLineItemsChangeValue Example to create an instance using the builder pattern
ChangeTargetLineItemsChangeValueBuilder Example to create an instance using the builder pattern
ChangeTargetLineItemsChangeValue
ChangeTargetMultiBuyCustomLineItemsChangeValue Example to create an instance using the builder pattern
ChangeTargetMultiBuyCustomLineItemsChangeValueBuilder Example to create an instance using the builder pattern
ChangeTargetMultiBuyCustomLineItemsChangeValue
ChangeTargetMultiBuyLineItemsChangeValue Example to create an instance using the builder pattern
ChangeTargetMultiBuyLineItemsChangeValueBuilder Example to create an instance using the builder pattern
ChangeTargetMultiBuyLineItemsChangeValue
ChangeTargetShippingChangeValue Example to create an instance using the builder pattern
ChangeTargetShippingChangeValueBuilder Example to create an instance using the builder pattern
ChangeTargetShippingChangeValue
Change triggered by the Change TaxCalculationMode update action.
ChangeTaxCalculationModeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TaxCalculationMode update action.
Change triggered by the Change TaxMode update action.
ChangeTaxModeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TaxMode update action.
Change triggered by the Change Tax RoundingMode update action.
ChangeTaxRoundingModeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change Tax RoundingMode update action.
Change triggered by the Change TextLineItem Name update action.
ChangeTextLineItemNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TextLineItem Name update action.
Change triggered by the Change TextLineItem Quantity update action.
ChangeTextLineItemQuantityChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TextLineItem Quantity update action.
Change triggered by the Change TextLineItems Order update action.
ChangeTextLineItemsOrderChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TextLineItems Order update action.
Change triggered by the Change TransactionInteractionId update action.
ChangeTransactionInteractionIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TransactionInteractionId update action.
Change triggered by the Change TransactionState update action.
ChangeTransactionStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TransactionState update action.
Change triggered by the Change TransactionTimestamp update action.
ChangeTransactionTimestampChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Change TransactionTimestamp update action.
ChangeValueAbsoluteChangeValue Example to create an instance using the builder pattern
ChangeValueAbsoluteChangeValueBuilder Example to create an instance using the builder pattern
ChangeValueAbsoluteChangeValue
Change triggered by the following update actions:
ChangeValueChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeValueChangeValue Example to create a subtype instance using the builder pattern
ChangeValueChangeValueBuilder
ChangeValueChangeValue
ChangeValueExternalChangeValue Example to create an instance using the builder pattern
ChangeValueExternalChangeValueBuilder Example to create an instance using the builder pattern
ChangeValueExternalChangeValue
ChangeValueGiftLineItemChangeValue Example to create an instance using the builder pattern
ChangeValueGiftLineItemChangeValueBuilder Example to create an instance using the builder pattern
ChangeValueGiftLineItemChangeValue
ChangeValueRelativeChangeValue Example to create an instance using the builder pattern
ChangeValueRelativeChangeValueBuilder Example to create an instance using the builder pattern
ChangeValueRelativeChangeValue
Channel Example to create an instance using the builder pattern
ChannelAddRolesAction Example to create an instance using the builder pattern
ChannelAddRolesActionBuilder Example to create an instance using the builder pattern
ChannelAddRolesAction
 
ChannelBuilder Example to create an instance using the builder pattern
ChannelChangeDescriptionAction Example to create an instance using the builder pattern
ChannelChangeDescriptionActionBuilder Example to create an instance using the builder pattern
ChannelChangeDescriptionAction
 
ChannelChangeKeyAction Example to create an instance using the builder pattern
ChannelChangeKeyActionBuilder Example to create an instance using the builder pattern
ChannelChangeKeyAction
 
ChannelChangeNameAction Example to create an instance using the builder pattern
ChannelChangeNameActionBuilder Example to create an instance using the builder pattern
ChannelChangeNameAction
 
ChannelDraft Example to create an instance using the builder pattern
ChannelDraftBuilder Example to create an instance using the builder pattern
ChannelDraft
 
Channel
References a channel by key.
ChannelKeyReferenceBuilder Example to create an instance using the builder pattern
References a channel by key.
 
PagedQueryResult with results containing an array of Channel.
ChannelPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Channel.
 
 
Reference to a Channel.
ChannelReferenceBuilder Example to create an instance using the builder pattern
Reference to a Channel.
 
ChannelRemoveRolesAction Example to create an instance using the builder pattern
ChannelRemoveRolesActionBuilder Example to create an instance using the builder pattern
ChannelRemoveRolesAction
 
ResourceIdentifier to a Channel.
ChannelResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Channel.
 
ChannelRole
possible values of ChannelRole
Describes the purpose and type of the Channel.
possible values of ChannelRoleEnum
ChannelSetAddressAction Example to create an instance using the builder pattern
ChannelSetAddressActionBuilder Example to create an instance using the builder pattern
ChannelSetAddressAction
 
ChannelSetAddressCustomFieldAction Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldAction
 
ChannelSetAddressCustomTypeAction Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeAction
 
ChannelSetCustomFieldAction Example to create an instance using the builder pattern
ChannelSetCustomFieldActionBuilder Example to create an instance using the builder pattern
ChannelSetCustomFieldAction
 
ChannelSetCustomTypeAction Example to create an instance using the builder pattern
ChannelSetCustomTypeActionBuilder Example to create an instance using the builder pattern
ChannelSetCustomTypeAction
 
ChannelSetGeoLocationAction Example to create an instance using the builder pattern
ChannelSetGeoLocationActionBuilder Example to create an instance using the builder pattern
ChannelSetGeoLocationAction
 
ChannelSetRolesAction Example to create an instance using the builder pattern
ChannelSetRolesActionBuilder Example to create an instance using the builder pattern
ChannelSetRolesAction
 
ChannelUpdate Example to create an instance using the builder pattern
ChannelUpdateAction Example to create a subtype instance using the builder pattern
ChannelUpdateActionBuilder
ChannelUpdateAction
 
ChannelUpdateBuilder Example to create an instance using the builder pattern
ChannelUpdate
 
ClassificationShippingRateInput Example to create an instance using the builder pattern
ClassificationShippingRateInput Example to create an instance using the builder pattern
ClassificationShippingRateInputBuilder Example to create an instance using the builder pattern
ClassificationShippingRateInputBuilder Example to create an instance using the builder pattern
ClassificationShippingRateInputDraft Example to create an instance using the builder pattern
ClassificationShippingRateInputDraftBuilder Example to create an instance using the builder pattern
ClassificationShippingRateInputDraft
 
ClassificationShippingRateInput
ClassificationShippingRateInput
 
 
The ClientBuilder is used to configure and create an ApiHttpClient.
 
 
 
Token supplier using client credentials flow
Deprecated.
use ClientBuilder instead
These objects represent information about which API Client created or modified a resource.
ClientLoggingBuilder Example to create an instance using the builder pattern
These objects represent information about which API Client created or modified a resource.
 
 
 
The CloudEventsFormat can be used with any Destination, and the payload is delivered in the JSON Event Format.
CloudEventsFormatBuilder Example to create an instance using the builder pattern
The CloudEventsFormat can be used with any Destination, and the payload is delivered in the JSON Event Format.
 
The CloudEventsFormat represents event data in a way that conforms to a common specification.
CloudEventsPayloadBuilder Example to create an instance using the builder pattern
The CloudEventsFormat represents event data in a way that conforms to a common specification.
 
 
 
 
 
Business Unit type to represent the top level of a business.
CompanyBuilder Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
CompanyDraftBuilder Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
 
Business Unit type to represent the top level of a business.
 
 
 
 
 
 
 
 
 
 
Tools to simplify the work with CompletionStage and CompletableFuture.
Returned when the request conflicts with the current state of the involved resources.
The request conflicts with the current state of the involved resources.
ConcurrentModificationErrorBuilder Example to create an instance using the builder pattern
ConcurrentModificationErrorBuilder Example to create an instance using the builder pattern
Returned when the request conflicts with the current state of the involved resources.
The request conflicts with the current state of the involved resources.
 
Deserializes the response payload as ErrorResponse and extracts the currentVersion of the modified resource if included
 
Middleware to retry a request upon ConcurrentModificationException
String projectKey = CommercetoolsTestUtils.getProjectKey();

ProjectApiRoot projectApiRoot = ApiRootBuilder.of()
        .defaultClient(ClientCredentials.of()
                .withClientId(CommercetoolsTestUtils.getClientId())
                .withClientSecret(CommercetoolsTestUtils.getClientSecret())
                .build(),
            ServiceRegion.GCP_EUROPE_WEST1)
        .addConcurrentModificationMiddleware(3)
        .build(projectKey);

CartsFixtures.withUpdateableCart(cart -> {

    final ApiHttpResponse<Cart> deCart = projectApiRoot.carts()
            .withId(cart.getId())
            .post(CartUpdateBuilder.of()
                    .version(cart.getVersion())
                    .actions(CartSetCountryActionBuilder.of().country("DE").build())
                    .build())
            .executeBlocking();

    final Cart modCart = projectApiRoot.carts()
            .withId(cart.getId())
            .post(CartUpdateBuilder.of()
                    .version(cart.getVersion())
                    .actions(CartSetCountryActionBuilder.of().country("DE").build())
                    .build())
            .executeBlocking()
            .getBody();
    return modCart;
});

See the test code.

Implementation of the ConcurrentModificationMiddleware.
ConflictingTrait
This destination can be used to push events and messages to Confluent Cloud.
ConfluentCloudDestinationBuilder Example to create an instance using the builder pattern
This destination can be used to push events and messages to Confluent Cloud.
 
 
 
ContainerAndKey is specific to Custom Objects.
ContainerAndKeyBuilder Example to create an instance using the builder pattern
ContainerAndKey is specific to Custom Objects.
 
 
 
 
ContentionError Example to create an instance using the builder pattern
ContentionErrorBuilder Example to create an instance using the builder pattern
ContentionError
 
 
 
 
Provider for a correlation id which may be added to a request as unique identifier
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
CountryNotConfiguredInStoreErrorBuilder Example to create an instance using the builder pattern
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
 
Present on resources created after 1 February 2019 except for events not tracked.
CreatedByBuilder Example to create an instance using the builder pattern
Present on resources created after 1 February 2019 except for events not tracked.
 
 
 
 
 
 
The representation to be sent to the server when creating a resource with custom fields.
CustomBuilder Example to create an instance using the builder pattern
If stores is not empty, the Customer is specific to those Stores.
Adding an address to the Customer produces the CustomerAddressAdded Message.
CustomerAddAddressActionBuilder Example to create an instance using the builder pattern
Adding an address to the Customer produces the CustomerAddressAdded Message.
 
Adds an Address from the addresses array to billingAddressIds.
CustomerAddBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Adds an Address from the addresses array to billingAddressIds.
 
Different from Address in that key is required and id is not supported.
Generated after a successful Add Address update action.
CustomerAddressAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
Generated after a successful Add Address update action.
CustomerAddressAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
 
 
CustomerAddressBuilder Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
CustomerAddressChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
Generated after a successful Change Address update action.
CustomerAddressChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
 
 
Different from Address in that key is required and id is not supported.
Generated after a successful Remove Address update action.
CustomerAddressRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
Generated after a successful Remove Address update action.
CustomerAddressRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
 
 
Adds an Address from the addresses array to shippingAddressIds.
CustomerAddShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Adds an Address from the addresses array to shippingAddressIds.
 
Associates the Customer with a Store.
CustomerAddStoreActionBuilder Example to create an instance using the builder pattern
Associates the Customer with a Store.
 
CustomerBuilder Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
CustomerChangeAddressActionBuilder Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
 
Changing the email of the Customer produces the CustomerEmailChanged Message.
CustomerChangeEmailActionBuilder Example to create an instance using the builder pattern
Changing the email of the Customer produces the CustomerEmailChanged Message.
 
CustomerChangePassword Example to create an instance using the builder pattern
CustomerChangePasswordBuilder Example to create an instance using the builder pattern
CustomerChangePassword
 
Generated after a successful Set Company Name update action.
CustomerCompanyNameSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Company Name update action.
Generated after a successful Set Company Name update action.
CustomerCompanyNameSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Company Name update action.
 
 
Generated after a successful Create Customer request.
CustomerCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
Generated after a successful Create Customer request.
CustomerCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
 
 
CustomerCreateEmailToken Example to create an instance using the builder pattern
CustomerCreateEmailTokenBuilder Example to create an instance using the builder pattern
CustomerCreateEmailToken
 
CustomerCreatePasswordResetToken Example to create an instance using the builder pattern
CustomerCreatePasswordResetTokenBuilder Example to create an instance using the builder pattern
CustomerCreatePasswordResetToken
 
Generated after a successful Set Date of Birth update action.
CustomerDateOfBirthSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Date of Birth update action.
Generated after a successful Set Date of Birth update action.
CustomerDateOfBirthSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Date of Birth update action.
 
 
Generated after a successful Delete Customer request.
CustomerDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
Generated after a successful Delete Customer request.
CustomerDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
 
 
CustomerDraft Example to create an instance using the builder pattern
CustomerDraftBuilder Example to create an instance using the builder pattern
CustomerDraft
 
 
Generated after a successful Change Email update action.
CustomerEmailChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Email update action.
Generated after a successful Change Email update action.
CustomerEmailChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Email update action.
 
 
Generated after a successful Verify Customer's Email request.
CustomerEmailVerifiedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Verify Customer's Email request.
Generated after a successful Verify Customer's Email request.
CustomerEmailVerifiedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Verify Customer's Email request.
 
 
CustomerEmailVerify Example to create an instance using the builder pattern
CustomerEmailVerifyBuilder Example to create an instance using the builder pattern
CustomerEmailVerify
 
Generated after a successful Set First Name update action.
CustomerFirstNameSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set First Name update action.
Generated after a successful Set First Name update action.
CustomerFirstNameSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set First Name update action.
 
 
CustomerGroup Example to create an instance using the builder pattern
CustomerGroupBuilder Example to create an instance using the builder pattern
CustomerGroupChangeNameAction Example to create an instance using the builder pattern
CustomerGroupChangeNameActionBuilder Example to create an instance using the builder pattern
CustomerGroupChangeNameAction
 
CustomerGroupDraft Example to create an instance using the builder pattern
CustomerGroupDraftBuilder Example to create an instance using the builder pattern
CustomerGroupDraft
 
CustomerGroup
References a customer group by key.
CustomerGroupKeyReferenceBuilder Example to create an instance using the builder pattern
References a customer group by key.
 
PagedQueryResult with results containing an array of CustomerGroup.
CustomerGroupPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of CustomerGroup.
 
 
Reference to a CustomerGroup.
CustomerGroupReferenceBuilder Example to create an instance using the builder pattern
Reference to a CustomerGroup.
 
ResourceIdentifier to a CustomerGroup.
CustomerGroupResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a CustomerGroup.
 
CustomerGroupSetCustomFieldAction Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldActionBuilder Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldAction
 
This action sets or removes the custom type for an existing CustomerGroup.
CustomerGroupSetCustomTypeActionBuilder Example to create an instance using the builder pattern
This action sets or removes the custom type for an existing CustomerGroup.
 
CustomerGroupSetKeyAction Example to create an instance using the builder pattern
CustomerGroupSetKeyActionBuilder Example to create an instance using the builder pattern
CustomerGroupSetKeyAction
 
Generated after a successful Set Customer Group update action.
CustomerGroupSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
Generated after a successful Set Customer Group update action.
CustomerGroupSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
 
 
CustomerGroupUpdate Example to create an instance using the builder pattern
CustomerGroupUpdateAction Example to create a subtype instance using the builder pattern
CustomerGroupUpdateActionBuilder
CustomerGroupUpdateAction
 
CustomerGroupUpdateBuilder Example to create an instance using the builder pattern
CustomerGroupUpdate
 
If stores is not empty, the Customer is specific to those Stores.
The data representation for a Customer to be imported that is persisted as a Customer in the Project.
CustomerImportBuilder Example to create an instance using the builder pattern
The data representation for a Customer to be imported that is persisted as a Customer in the Project.
The request body to import Customers.
CustomerImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Customers.
References a customer by key.
CustomerKeyReferenceBuilder Example to create an instance using the builder pattern
References a customer by key.
CustomerLabel Example to create an instance using the builder pattern
CustomerLabelBuilder Example to create an instance using the builder pattern
CustomerLabel
Generated after a successful Set Last Name update action.
CustomerLastNameSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Last Name update action.
Generated after a successful Set Last Name update action.
CustomerLastNameSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Last Name update action.
 
 
 
PagedQueryResult with results containing an array of Customer.
CustomerPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Customer.
 
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
CustomerPasswordUpdatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
CustomerPasswordUpdatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
 
 
 
Reference to a Customer.
CustomerReferenceBuilder Example to create an instance using the builder pattern
Reference to a Customer.
 
Removing an address from the Customer produces the CustomerAddressRemoved Message.
CustomerRemoveAddressActionBuilder Example to create an instance using the builder pattern
Removing an address from the Customer produces the CustomerAddressRemoved Message.
 
Removes a billing address from billingAddressesIds.
CustomerRemoveBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Removes a billing address from billingAddressesIds.
 
Removes a shipping address from shippingAddressesIds.
CustomerRemoveShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Removes a shipping address from shippingAddressesIds.
 
Removes the association to a Store from the Customer.
CustomerRemoveStoreActionBuilder Example to create an instance using the builder pattern
Removes the association to a Store from the Customer.
 
CustomerResetPassword Example to create an instance using the builder pattern
CustomerResetPasswordBuilder Example to create an instance using the builder pattern
CustomerResetPassword
 
ResourceIdentifier to a Customer.
CustomerResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Customer.
 
CustomerSetAddressCustomFieldAction Example to create an instance using the builder pattern
CustomerSetAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
CustomerSetAddressCustomFieldAction
 
CustomerSetAddressCustomTypeAction Example to create an instance using the builder pattern
CustomerSetAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
CustomerSetAddressCustomTypeAction
 
CustomerSetAuthenticationModeAction Example to create an instance using the builder pattern
CustomerSetAuthenticationModeActionBuilder Example to create an instance using the builder pattern
CustomerSetAuthenticationModeAction
 
Setting a company name produces the CustomerCompanyNameSet Message.
CustomerSetCompanyNameActionBuilder Example to create an instance using the builder pattern
Setting a company name produces the CustomerCompanyNameSet Message.
 
Setting the Customer Group of the Customer produces the CustomerGroupSet Message.
CustomerSetCustomerGroupActionBuilder Example to create an instance using the builder pattern
Setting the Customer Group of the Customer produces the CustomerGroupSet Message.
 
Sets a new ID that can be used to refer to a Customer in a human-reabable way (for use in emails, invoices, etc).
CustomerSetCustomerNumberActionBuilder Example to create an instance using the builder pattern
Sets a new ID that can be used to refer to a Customer in a human-reabable way (for use in emails, invoices, etc).
 
CustomerSetCustomFieldAction Example to create an instance using the builder pattern
CustomerSetCustomFieldActionBuilder Example to create an instance using the builder pattern
CustomerSetCustomFieldAction
 
CustomerSetCustomTypeAction Example to create an instance using the builder pattern
CustomerSetCustomTypeActionBuilder Example to create an instance using the builder pattern
CustomerSetCustomTypeAction
 
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
CustomerSetDateOfBirthActionBuilder Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
 
Sets the default billing address from addresses.
CustomerSetDefaultBillingAddressActionBuilder Example to create an instance using the builder pattern
Sets the default billing address from addresses.
 
Sets the default shipping address from addresses.
CustomerSetDefaultShippingAddressActionBuilder Example to create an instance using the builder pattern
Sets the default shipping address from addresses.
 
CustomerSetExternalIdAction Example to create an instance using the builder pattern
CustomerSetExternalIdActionBuilder Example to create an instance using the builder pattern
CustomerSetExternalIdAction
 
CustomerSetFirstNameAction Example to create an instance using the builder pattern
CustomerSetFirstNameActionBuilder Example to create an instance using the builder pattern
CustomerSetFirstNameAction
 
CustomerSetKeyAction Example to create an instance using the builder pattern
CustomerSetKeyActionBuilder Example to create an instance using the builder pattern
CustomerSetKeyAction
 
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
CustomerSetLastNameActionBuilder Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
 
CustomerSetLocaleAction Example to create an instance using the builder pattern
CustomerSetLocaleActionBuilder Example to create an instance using the builder pattern
CustomerSetLocaleAction
 
CustomerSetMiddleNameAction Example to create an instance using the builder pattern
CustomerSetMiddleNameActionBuilder Example to create an instance using the builder pattern
CustomerSetMiddleNameAction
 
CustomerSetSalutationAction Example to create an instance using the builder pattern
CustomerSetSalutationActionBuilder Example to create an instance using the builder pattern
CustomerSetSalutationAction
 
Sets the Stores the Customer account is associated with.
CustomerSetStoresActionBuilder Example to create an instance using the builder pattern
Sets the Stores the Customer account is associated with.
 
Setting the title of the Customer produces the CustomerTitleSetMessage.
CustomerSetTitleActionBuilder Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSetMessage.
 
CustomerSetVatIdAction Example to create an instance using the builder pattern
CustomerSetVatIdActionBuilder Example to create an instance using the builder pattern
CustomerSetVatIdAction
 
CustomerSignin Example to create an instance using the builder pattern
CustomerSigninBuilder Example to create an instance using the builder pattern
CustomerSignin
 
CustomerSignInResult Example to create an instance using the builder pattern
CustomerSignInResultBuilder Example to create an instance using the builder pattern
CustomerSignInResult
 
Generated after a successful Set Title update action.
CustomerTitleSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Title update action.
Generated after a successful Set Title update action.
CustomerTitleSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Title update action.
 
 
CustomerToken Example to create an instance using the builder pattern
CustomerTokenBuilder Example to create an instance using the builder pattern
CustomerToken
 
CustomerUpdate Example to create an instance using the builder pattern
CustomerUpdateAction Example to create a subtype instance using the builder pattern
CustomerUpdateActionBuilder
CustomerUpdateAction
 
CustomerUpdateBuilder Example to create an instance using the builder pattern
CustomerUpdate
 
Provides the value for a custom field of a specific type.
Field type for Boolean values.
Field type for Boolean values.
CustomFieldBooleanTypeBuilder Example to create an instance using the builder pattern
CustomFieldBooleanTypeBuilder Example to create an instance using the builder pattern
Field type for Boolean values.
Field type for Boolean values.
 
CustomFieldBuilder
Field type for DateTime values.
Field type for DateTime values.
CustomFieldDateTimeTypeBuilder Example to create an instance using the builder pattern
CustomFieldDateTimeTypeBuilder Example to create an instance using the builder pattern
Field type for DateTime values.
Field type for DateTime values.
 
Field type for Date values.
Field type for Date values.
CustomFieldDateTypeBuilder Example to create an instance using the builder pattern
CustomFieldDateTypeBuilder Example to create an instance using the builder pattern
Field type for Date values.
Field type for Date values.
 
 
Field type for enum values.
Field type for enum values.
CustomFieldEnumTypeBuilder Example to create an instance using the builder pattern
CustomFieldEnumTypeBuilder Example to create an instance using the builder pattern
Field type for enum values.
Field type for enum values.
 
Defines an allowed value of a CustomFieldEnumType field.
Defines an allowed value of a CustomFieldEnumType field.
CustomFieldEnumValueBuilder Example to create an instance using the builder pattern
CustomFieldEnumValueBuilder Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldEnumType field.
Defines an allowed value of a CustomFieldEnumType field.
 
Only present if expand is set to true.
CustomFieldExpandedValueBuilder Example to create an instance using the builder pattern
Only present if expand is set to true.
Provides the value for a custom field of a specific type.
Field type for localized enum values.
Field type for localized enum values.
CustomFieldLocalizedEnumTypeBuilder Example to create an instance using the builder pattern
CustomFieldLocalizedEnumTypeBuilder Example to create an instance using the builder pattern
Field type for localized enum values.
Field type for localized enum values.
 
Defines an allowed value of a CustomFieldLocalizedEnumType field.
Defines an allowed value of a CustomFieldLocalizedEnumType field.
CustomFieldLocalizedEnumValueBuilder Example to create an instance using the builder pattern
CustomFieldLocalizedEnumValueBuilder Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldLocalizedEnumType field.
Defines an allowed value of a CustomFieldLocalizedEnumType field.
 
Field type for LocalizedString values.
Field type for LocalizedString values.
CustomFieldLocalizedStringTypeBuilder Example to create an instance using the builder pattern
CustomFieldLocalizedStringTypeBuilder Example to create an instance using the builder pattern
Field type for LocalizedString values.
Field type for LocalizedString values.
 
Field type for CentPrecisionMoney values.
Field type for CentPrecisionMoney values.
CustomFieldMoneyTypeBuilder Example to create an instance using the builder pattern
CustomFieldMoneyTypeBuilder Example to create an instance using the builder pattern
Field type for CentPrecisionMoney values.
Field type for CentPrecisionMoney values.
 
Field type for number values.
Field type for number values.
CustomFieldNumberTypeBuilder Example to create an instance using the builder pattern
CustomFieldNumberTypeBuilder Example to create an instance using the builder pattern
Field type for number values.
Field type for number values.
 
Field type for Reference values.
Field type for Reference values.
CustomFieldReferenceTypeBuilder Example to create an instance using the builder pattern
CustomFieldReferenceTypeBuilder Example to create an instance using the builder pattern
Field type for Reference values.
Field type for Reference values.
 
Defines which resource type a CustomFieldReferenceType can reference.
Defines which resource type a CustomFieldReferenceType can reference.
possible values of CustomFieldReferenceValue
possible values of CustomFieldReferenceValue
Serves as value of the custom field on a resource or data type customized with a Type.
CustomFields Example to create an instance using the builder pattern
Accessor for retrieving type safe custom field values
CustomFieldsBuilder Example to create an instance using the builder pattern
CustomFieldsBuilder Example to create an instance using the builder pattern
The representation used when creating or updating a customizable data type with Custom Fields.
CustomFieldsDraftBuilder Example to create an instance using the builder pattern
The representation used when creating or updating a customizable data type with Custom Fields.
 
Values of a SetType Custom Field are sets of values of the specified elementType (without duplicate elements).
Values of a SetType Custom Field are sets of values of the specified elementType (without duplicate elements).
CustomFieldSetTypeBuilder Example to create an instance using the builder pattern
CustomFieldSetTypeBuilder Example to create an instance using the builder pattern
Values of a SetType Custom Field are sets of values of the specified elementType (without duplicate elements).
Values of a SetType Custom Field are sets of values of the specified elementType (without duplicate elements).
 
Serves as value of the custom field on a resource or data type customized with a Type.
CustomFields
 
 
Field type for string values.
Field type for string values.
CustomFieldStringTypeBuilder Example to create an instance using the builder pattern
CustomFieldStringTypeBuilder Example to create an instance using the builder pattern
Field type for string values.
Field type for string values.
 
Field type for Time values.
Field type for Time values.
CustomFieldTimeTypeBuilder Example to create an instance using the builder pattern
CustomFieldTimeTypeBuilder Example to create an instance using the builder pattern
Field type for Time values.
Field type for Time values.
 
The representation to be sent to the server when creating a resource with custom fields.
Entity with a CustomField property
Entity with a CustomFieldDraft property
A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.
CustomLineItem Example to create an instance using the builder pattern
CustomLineItemBuilder Example to create an instance using the builder pattern
CustomLineItemBuilder Example to create an instance using the builder pattern
CustomLineItemDraft Example to create an instance using the builder pattern
CustomLineItemDraft Example to create an instance using the builder pattern
CustomLineItemDraftBuilder Example to create an instance using the builder pattern
CustomLineItemDraftBuilder Example to create an instance using the builder pattern
CustomLineItemDraft
CustomLineItemDraft
 
A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.
CustomLineItem
CustomLineItemImportDraft Example to create an instance using the builder pattern
CustomLineItemImportDraftBuilder Example to create an instance using the builder pattern
CustomLineItemImportDraft
 
Determines if Cart Discounts can be applied to a Custom Line Item in the Cart.
possible values of CustomLineItemPriceMode
 
CustomLineItemReturnItem Example to create an instance using the builder pattern
CustomLineItemReturnItemBuilder Example to create an instance using the builder pattern
CustomLineItemReturnItem
 
Generated after a successful Transition Custom Line Item State update action.
CustomLineItemStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition Custom Line Item State update action.
Generated after a successful Transition Custom Line Item State update action.
CustomLineItemStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition Custom Line Item State update action.
 
 
CustomLineItemTaxedPrice Example to create an instance using the builder pattern
CustomLineItemTaxedPriceBuilder Example to create an instance using the builder pattern
CustomLineItemTaxedPrice
CustomObject Example to create an instance using the builder pattern
CustomObjectBuilder Example to create an instance using the builder pattern
CustomObjectDraft Example to create an instance using the builder pattern
CustomObjectDraftBuilder Example to create an instance using the builder pattern
CustomObjectDraft
 
CustomObject
References a key value document by key.
CustomObjectKeyReferenceBuilder Example to create an instance using the builder pattern
References a key value document by key.
CustomObjectLabel Example to create an instance using the builder pattern
CustomObjectLabelBuilder Example to create an instance using the builder pattern
CustomObjectLabel
 
PagedQueryResult with results containing an array of CustomObject.
CustomObjectPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of CustomObject.
 
 
Reference to a CustomObject.
CustomObjectReferenceBuilder Example to create an instance using the builder pattern
Reference to a CustomObject.
 
CustomShippingDraft Example to create an instance using the builder pattern
CustomShippingDraftBuilder Example to create an instance using the builder pattern
CustomShippingDraft
 
CustomShippingMethodChangeValue Example to create an instance using the builder pattern
CustomShippingMethodChangeValueBuilder Example to create an instance using the builder pattern
CustomShippingMethodChangeValue
Define arbitrary tokens that are used to match the input.
CustomTokenizer Example to create an instance using the builder pattern
CustomTokenizerBuilder Example to create an instance using the builder pattern
CustomTokenizerBuilder Example to create an instance using the builder pattern
Define arbitrary tokens that are used to match the input.
CustomTokenizer
 
DataerasureTrait
This type represents an attribute whose value is a date.
DateAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a date.
 
 
A field with a date value.
DateFieldBuilder Example to create an instance using the builder pattern
A field with a date value.
This type represents an attribute whose value is a set of dates.
DateSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of dates.
A field with a date set value.
DateSetFieldBuilder Example to create an instance using the builder pattern
A field with a date set value.
This type consists of one enum value:
possible values of DateStringFilter
This type represents an attribute whose value is a date with time.
DateTimeAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a date with time.
 
 
A field with a date time value.
DateTimeFieldBuilder Example to create an instance using the builder pattern
A field with a date time value.
This type represents an attribute whose value is a set of dates with time.
DateTimeSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of dates with time.
A field with a date time set value.
DateTimeSetFieldBuilder Example to create an instance using the builder pattern
A field with a date time set value.
 
 
 
Delivery Example to create an instance using the builder pattern
Delivery Example to create an instance using the builder pattern
Delivery Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
DeliveryAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
Generated after a successful Add Delivery update action.
DeliveryAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
 
 
DeliveryAddressDraft Example to create an instance using the builder pattern
DeliveryAddressDraftBuilder Example to create an instance using the builder pattern
DeliveryAddressDraft
Generated after a successful Set Delivery Address update action.
DeliveryAddressSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Delivery Address update action.
Generated after a successful Set Delivery Address update action.
DeliveryAddressSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Delivery Address update action.
 
 
DeliveryBuilder Example to create an instance using the builder pattern
DeliveryBuilder Example to create an instance using the builder pattern
DeliveryBuilder Example to create an instance using the builder pattern
DeliveryChangeValue Example to create an instance using the builder pattern
DeliveryChangeValueBuilder Example to create an instance using the builder pattern
DeliveryChangeValue
Deprecated.
use CloudEventsFormat instead
Deprecated.
DeliveryDraft Example to create an instance using the builder pattern
DeliveryDraft Example to create an instance using the builder pattern
DeliveryDraftBuilder Example to create an instance using the builder pattern
DeliveryDraftBuilder Example to create an instance using the builder pattern
DeliveryDraft
DeliveryDraft
 
DeliveryFormat Example to create a subtype instance using the builder pattern
DeliveryFormatBuilder
DeliveryFormat
 
Delivery
Delivery
Delivery
DeliveryItem Example to create an instance using the builder pattern
DeliveryItem Example to create an instance using the builder pattern
DeliveryItem Example to create an instance using the builder pattern
DeliveryItemBuilder Example to create an instance using the builder pattern
DeliveryItemBuilder Example to create an instance using the builder pattern
DeliveryItemBuilder Example to create an instance using the builder pattern
DeliveryItem
DeliveryItem
DeliveryItem
 
Generated after a successful Set Delivery Items update action.
DeliveryItemsUpdatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Delivery Items update action.
Generated after a successful Set Delivery Items update action.
DeliveryItemsUpdatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Delivery Items update action.
 
 
 
DeliveryParcel Example to create an instance using the builder pattern
DeliveryParcelBuilder Example to create an instance using the builder pattern
DeliveryParcelDraft Example to create an instance using the builder pattern
DeliveryParcelDraftBuilder Example to create an instance using the builder pattern
DeliveryParcelDraft
DeliveryParcel
All payloads for the PlatformFormat share these common fields.
DeliveryPayloadBuilder
All payloads for the PlatformFormat share these common fields.
 
Deprecated.
use PlatformFormat instead
Deprecated.
 
Generated after a successful Remove Delivery update action.
DeliveryRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Delivery update action.
Generated after a successful Remove Delivery update action.
DeliveryRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Delivery update action.
 
 
Deprecatable200Trait
Deprecatable201Trait
 
Destination Example to create a subtype instance using the builder pattern
DestinationBuilder
Destination
 
Represents a CartDiscount that is only associated with a single Cart or Order.
DirectDiscountBuilder Example to create an instance using the builder pattern
Represents a CartDiscount that can only be associated with a single Cart or Order.
DirectDiscountDraftBuilder Example to create an instance using the builder pattern
Represents a CartDiscount that can only be associated with a single Cart or Order.
 
Represents a CartDiscount that is only associated with a single Cart or Order.
 
Reference to a DirectDiscount.
DirectDiscountReferenceBuilder Example to create an instance using the builder pattern
Reference to a DirectDiscount.
 
DiscountCode Example to create an instance using the builder pattern
DiscountCodeBuilder Example to create an instance using the builder pattern
DiscountCodeChangeCartDiscountsAction Example to create an instance using the builder pattern
DiscountCodeChangeCartDiscountsActionBuilder Example to create an instance using the builder pattern
DiscountCodeChangeCartDiscountsAction
 
DiscountCodeChangeGroupsAction Example to create an instance using the builder pattern
DiscountCodeChangeGroupsActionBuilder Example to create an instance using the builder pattern
DiscountCodeChangeGroupsAction
 
DiscountCodeChangeIsActiveAction Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveActionBuilder Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveAction
 
DiscountCodeDraft Example to create an instance using the builder pattern
DiscountCodeDraftBuilder Example to create an instance using the builder pattern
DiscountCodeDraft
 
DiscountCode
DiscountCodeInfo Example to create an instance using the builder pattern
DiscountCodeInfo Example to create an instance using the builder pattern
DiscountCodeInfo Example to create an instance using the builder pattern
DiscountCodeInfoBuilder Example to create an instance using the builder pattern
DiscountCodeInfoBuilder Example to create an instance using the builder pattern
DiscountCodeInfoBuilder Example to create an instance using the builder pattern
DiscountCodeInfo
DiscountCodeInfo
DiscountCodeInfo
 
References a discount code by key.
DiscountCodeKeyReferenceBuilder Example to create an instance using the builder pattern
References a discount code by key.
 
Returned when the Cart contains a Discount Code with a DiscountCodeState other than MatchesCart.
DiscountCodeNonApplicableErrorBuilder Example to create an instance using the builder pattern
Returned when the Cart contains a Discount Code with a DiscountCodeState other than MatchesCart.
 
PagedQueryResult with results containing an array of DiscountCode.
DiscountCodePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of DiscountCode.
 
 
Reference to a DiscountCode.
DiscountCodeReferenceBuilder Example to create an instance using the builder pattern
Reference to a DiscountCode.
 
ResourceIdentifier to a DiscountCode.
DiscountCodeResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a DiscountCode.
 
DiscountCodeSetCartPredicateAction Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateAction
 
DiscountCodeSetCustomFieldAction Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldAction
 
DiscountCodeSetCustomTypeAction Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeAction
 
DiscountCodeSetDescriptionAction Example to create an instance using the builder pattern
DiscountCodeSetDescriptionActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetDescriptionAction
 
DiscountCodeSetMaxApplicationsAction Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsAction
 
DiscountCodeSetMaxApplicationsPerCustomerAction Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerAction
 
DiscountCodeSetNameAction Example to create an instance using the builder pattern
DiscountCodeSetNameActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetNameAction
 
DiscountCodeSetValidFromAction Example to create an instance using the builder pattern
DiscountCodeSetValidFromActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetValidFromAction
 
DiscountCodeSetValidFromAndUntilAction Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilAction
 
DiscountCodeSetValidUntilAction Example to create an instance using the builder pattern
DiscountCodeSetValidUntilActionBuilder Example to create an instance using the builder pattern
DiscountCodeSetValidUntilAction
 
Indicates the state of a Discount Code in a Cart.
DiscountCodeState
Maps to DiscountCodeInfo.state
possible values of DiscountCodeState
possible values of DiscountCodeState
possible values of DiscountCodeState
DiscountCodeUpdate Example to create an instance using the builder pattern
DiscountCodeUpdateAction Example to create a subtype instance using the builder pattern
DiscountCodeUpdateActionBuilder
DiscountCodeUpdateAction
 
DiscountCodeUpdateBuilder Example to create an instance using the builder pattern
DiscountCodeUpdate
 
DiscountedLineItemPortion Example to create an instance using the builder pattern
DiscountedLineItemPortion Example to create an instance using the builder pattern
DiscountedLineItemPortion Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder Example to create an instance using the builder pattern
DiscountedLineItemPortion
DiscountedLineItemPortion
DiscountedLineItemPortion
 
DiscountedLineItemPrice Example to create an instance using the builder pattern
DiscountedLineItemPrice Example to create an instance using the builder pattern
DiscountedLineItemPriceBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft Example to create an instance using the builder pattern
DiscountedLineItemPriceDraftBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceDraftBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft
DiscountedLineItemPriceDraft
 
DiscountedLineItemPriceForQuantity Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantity Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantityBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantityBuilder Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantity
DiscountedLineItemPriceForQuantity
 
DiscountedLineItemPrice
DiscountedLineItemPrice
 
DiscountedPrice Example to create an instance using the builder pattern
DiscountedPrice Example to create an instance using the builder pattern
DiscountedPriceBuilder Example to create an instance using the builder pattern
DiscountedPriceBuilder Example to create an instance using the builder pattern
DiscountedPriceDraft Example to create an instance using the builder pattern
DiscountedPriceDraftBuilder Example to create an instance using the builder pattern
DiscountedPriceDraft
 
DiscountedPrice
DiscountedPrice
 
Business Unit type to model divisions that are part of the Company or a higher-order Division.
DivisionBuilder Example to create an instance using the builder pattern
Draft type to model divisions that are part of a Company or a higher-order Division.
DivisionDraftBuilder Example to create an instance using the builder pattern
Draft type to model divisions that are part of a Company or a higher-order Division.
 
Business Unit type to model divisions that are part of the Company or a higher-order Division.
 
Interface of a resource with an ID and version
 
 
 
 
Draft<T extends Draft<T>>
 
Returned when the Unique AttributeConstraint criteria are not met during an Update Product request.
The Unique AttributeConstraintEnum was violated.
DuplicateAttributeValueErrorBuilder Example to create an instance using the builder pattern
DuplicateAttributeValueErrorBuilder Example to create an instance using the builder pattern
Returned when the Unique AttributeConstraint criteria are not met during an Update Product request.
The Unique AttributeConstraintEnum was violated.
 
Returned when the CombinationUnique AttributeConstraint criteria are not met during an Update Product request.
The CombinationUnique AttributeConstraintEnum was violated.
DuplicateAttributeValuesErrorBuilder Example to create an instance using the builder pattern
DuplicateAttributeValuesErrorBuilder Example to create an instance using the builder pattern
Returned when the CombinationUnique AttributeConstraint criteria are not met during an Update Product request.
The CombinationUnique AttributeConstraintEnum was violated.
 
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
DuplicateEnumValuesErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
 
Returned when a field value conflicts with an existing value causing a duplicate.
The given value already exists for a field that is checked for unique values.
DuplicateFieldErrorBuilder Example to create an instance using the builder pattern
DuplicateFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value causing a duplicate.
The given value already exists for a field that is checked for unique values.
 
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
DuplicateFieldWithConflictingResourceErrorBuilder Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
 
Returned when a Price key conflicts with an existing key.
DuplicatePriceKeyErrorBuilder Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
 
Returned when a Price scope conflicts with an existing one during an Update Product request.
DuplicatePriceScopeErrorBuilder Example to create an instance using the builder pattern
Returned when a Price scope conflicts with an existing one during an Update Product request.
 
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
DuplicateStandalonePriceScopeErrorBuilder Example to create an instance using the builder pattern
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
 
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
The given combination of values of a Product Variant conflicts with an existing one.
DuplicateVariantValuesErrorBuilder Example to create an instance using the builder pattern
DuplicateVariantValuesErrorBuilder Example to create an instance using the builder pattern
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
The given combination of values of a Product Variant conflicts with an existing one.
 
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
EditPreviewFailedErrorBuilder Example to create an instance using the builder pattern
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
 
 
 
Supported endpoints
This type represents an attribute whose value is an enum.
EnumAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is an enum.
A field with an enum value.
EnumFieldBuilder Example to create an instance using the builder pattern
A field with an enum value.
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
EnumKeyAlreadyExistsErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
 
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
EnumKeyDoesNotExistErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
 
This type represents an attribute whose value is an enum.
EnumSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is an enum.
A field with an enum set value.
EnumSetFieldBuilder Example to create an instance using the builder pattern
A field with an enum set value.
EnumValue Example to create an instance using the builder pattern
EnumValue Example to create an instance using the builder pattern
EnumValueBuilder Example to create an instance using the builder pattern
EnumValueBuilder Example to create an instance using the builder pattern
EnumValue
EnumValue
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
EnumValueIsUsedErrorBuilder Example to create an instance using the builder pattern
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
 
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
EnumValuesMustMatchErrorBuilder Example to create an instance using the builder pattern
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
 
 
ErrorableTrait
ErrorByExtension Example to create an instance using the builder pattern
ErrorByExtensionBuilder Example to create an instance using the builder pattern
ErrorByExtension
 
Used to convert API errors to Exceptions.
 
Represents a single error.
ErrorObject Example to create an instance using the builder pattern
ErrorObject Example to create a subtype instance using the builder pattern
ErrorObjectBuilder
ErrorObjectBuilder Example to create an instance using the builder pattern
ErrorObjectBuilder
Represents a single error.
ErrorObject
ErrorObject
 
Base representation of an error response containing common fields to all errors.
ErrorResponse Example to create an instance using the builder pattern
The response in case of an error.
ErrorResponseBuilder Example to create an instance using the builder pattern
ErrorResponseBuilder Example to create an instance using the builder pattern
ErrorResponseBuilder Example to create an instance using the builder pattern
Exception which holds the response payload as ErrorResponse
Base representation of an error response containing common fields to all errors.
ErrorResponse
The response in case of an error.
 
AWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules.
EventBridgeDestinationBuilder Example to create an instance using the builder pattern
AWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules.
 
A function like Function but allows you to throw exception
Table of content The exception hierarchy documentation.
Deprecated.
 
ExpandableTrait
Extension Example to create an instance using the builder pattern
An Extension gets called during any of the following requests of an API call, but before the result is persisted.
possible values of ExtensionAction
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).
ExtensionBadResponseErrorBuilder Example to create an instance using the builder pattern
Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).
 
ExtensionBuilder Example to create an instance using the builder pattern
ExtensionChangeDestinationAction Example to create an instance using the builder pattern
ExtensionChangeDestinationActionBuilder Example to create an instance using the builder pattern
ExtensionChangeDestinationAction
 
ExtensionChangeTriggersAction Example to create an instance using the builder pattern
ExtensionChangeTriggersActionBuilder Example to create an instance using the builder pattern
ExtensionChangeTriggersAction
 
Generic type for destinations.
ExtensionDestinationBuilder
Generic type for destinations.
 
ExtensionDraft Example to create an instance using the builder pattern
ExtensionDraftBuilder Example to create an instance using the builder pattern
ExtensionDraft
 
ExtensionError Example to create an instance using the builder pattern
ExtensionErrorBuilder Example to create an instance using the builder pattern
ExtensionError
 
Deprecated.
use HttpDestination instead
Deprecated.
Deprecated.
Extension
ExtensionInput Example to create an instance using the builder pattern
ExtensionInputBuilder Example to create an instance using the builder pattern
ExtensionInput
 
Returned when the API Extension does not respond within the time limit, or could not be reached.
ExtensionNoResponseErrorBuilder Example to create an instance using the builder pattern
Returned when the API Extension does not respond within the time limit, or could not be reached.
 
PagedQueryResult with results containing an array of Extension.
ExtensionPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Extension.
 
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
ExtensionPredicateEvaluationFailedErrorBuilder Example to create an instance using the builder pattern
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
 
 
Extensions are available for:
possible values of ExtensionResourceTypeId
ExtensionSetKeyAction Example to create an instance using the builder pattern
ExtensionSetKeyActionBuilder Example to create an instance using the builder pattern
ExtensionSetKeyAction
 
ExtensionSetTimeoutInMsAction Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsActionBuilder Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsAction
 
ExtensionTrigger Example to create an instance using the builder pattern
ExtensionTriggerBuilder Example to create an instance using the builder pattern
ExtensionTrigger
 
ExtensionUpdate Example to create an instance using the builder pattern
ExtensionUpdateAction Example to create a subtype instance using the builder pattern
ExtensionUpdateActionBuilder
ExtensionUpdateAction
 
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
ExtensionUpdateActionsFailedErrorBuilder Example to create an instance using the builder pattern
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
 
ExtensionUpdateBuilder Example to create an instance using the builder pattern
ExtensionUpdate
 
ExternalLineItemTotalPrice Example to create an instance using the builder pattern
ExternalLineItemTotalPriceBuilder Example to create an instance using the builder pattern
ExternalLineItemTotalPrice
 
Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.
ExternalOAuthBuilder Example to create an instance using the builder pattern
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).
ExternalOAuthFailedErrorBuilder Example to create an instance using the builder pattern
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).
 
Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.
 
Cannot be used in LineItemDraft or CustomLineItemDraft.
ExternalTaxAmountDraftBuilder Example to create an instance using the builder pattern
Cannot be used in LineItemDraft or CustomLineItemDraft.
 
Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
ExternalTaxRateDraft Example to create an instance using the builder pattern
ExternalTaxRateDraftBuilder Example to create an instance using the builder pattern
ExternalTaxRateDraftBuilder Example to create an instance using the builder pattern
Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
ExternalTaxRateDraft
 
FacetRange Example to create an instance using the builder pattern
FacetRangeBuilder Example to create an instance using the builder pattern
FacetRange
 
FacetResult Example to create a subtype instance using the builder pattern
FacetResultBuilder
FacetResult
 
Deprecated.
use FacetRange instead
Deprecated.
use FacetRangeBuilder instead
FacetResults Example to create an instance using the builder pattern
Accessor to retrieve type safe facet results
Deprecated.
FacetResultsBuilder Example to create an instance using the builder pattern
FacetResults
 
Deprecated.
use FacetTerm instead
Deprecated.
use FacetTermBuilder instead
FacetTerm Example to create an instance using the builder pattern
FacetTermBuilder Example to create an instance using the builder pattern
FacetTerm
 
FacetTypes
possible values of FacetTypes
Interface to enable the configuration of Failsafe instances
MonetaryProvider which uses the FastMoney implementation.
Returned when the requested feature was removed.
FeatureRemovedErrorBuilder Example to create an instance using the builder pattern
Returned when the requested feature was removed.
 
FieldContainer Example to create an instance using the builder pattern
Maps the custom field names to the actual values.
FieldContainerBuilder Example to create an instance using the builder pattern
FieldContainerBuilder Example to create an instance using the builder pattern
FieldContainer
Maps the custom field names to the actual values.
 
 
Defines a Custom Field and its meta-information.
FieldDefinition Example to create an instance using the builder pattern
Defines a Custom Field and its meta-information.
FieldDefinitionBuilder Example to create an instance using the builder pattern
FieldDefinitionBuilder Example to create an instance using the builder pattern
FieldDefinitionBuilder Example to create an instance using the builder pattern
Defines a Custom Field and its meta-information.
FieldDefinition
Defines a Custom Field and its meta-information.
FieldDefinitionOrderValue Example to create an instance using the builder pattern
FieldDefinitionOrderValueBuilder Example to create an instance using the builder pattern
FieldDefinitionOrderValue
 
FieldType Example to create a subtype instance using the builder pattern
FieldType Example to create an instance using the builder pattern
FieldType Example to create a subtype instance using the builder pattern
FieldTypeBuilder
FieldTypeBuilder Example to create an instance using the builder pattern
FieldTypeBuilder
FieldType
FieldType
FieldType
 
 
 
 
FilteredFacetResult Example to create an instance using the builder pattern
FilteredFacetResultBuilder Example to create an instance using the builder pattern
FilteredFacetResult
 
 
 
GeneralCategoryRecommendation Example to create an instance using the builder pattern
GeneralCategoryRecommendationBuilder Example to create an instance using the builder pattern
GeneralCategoryRecommendation
GeneralCategoryRecommendationPagedQueryResponse Example to create an instance using the builder pattern
GeneralCategoryRecommendationPagedQueryResponseBuilder Example to create an instance using the builder pattern
GeneralCategoryRecommendationPagedQueryResponse
Table of content
Returned when a server-side problem occurs.
GeneralErrorBuilder Example to create an instance using the builder pattern
Returned when a server-side problem occurs.
 
 
entity to implement a type safe generic custom object
builder for a generic custom object
generic custom object implementation
GenericError Example to create an instance using the builder pattern
GenericErrorBuilder Example to create an instance using the builder pattern
GenericError
generic reference interface
generic reference implementation
GeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.
GeoJsonBuilder
GeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.
GeoJsonPoint Example to create an instance using the builder pattern
GeoJsonPointBuilder Example to create an instance using the builder pattern
GeoJsonPoint
 
 
 
GeoLocation Example to create an instance using the builder pattern
GeoLocationBuilder Example to create an instance using the builder pattern
GeoLocation
 
 
Token supplier using password flow
For GoogleCloudFunction destinations, you need to grant permissions to the extensions@commercetools-platform.iam.gserviceaccount.com service account to invoke your function.
GoogleCloudFunctionDestinationBuilder Example to create an instance using the builder pattern
For GoogleCloudFunction destinations, you need to grant permissions to the extensions@commercetools-platform.iam.gserviceaccount.com service account to invoke your function.
 
Destination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.
GoogleCloudPubSubDestinationBuilder Example to create an instance using the builder pattern
Destination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.
 
Returned when the anonymous ID is being used by another resource.
GraphQLAnonymousIdAlreadyInUseErrorBuilder Example to create an instance using the builder pattern
Returned when the anonymous ID is being used by another resource.
 
Returned when an Associate is missing a Permission on a B2B resource.
GraphQLAssociateMissingPermissionErrorBuilder Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
 
Returned when the name of the AttributeDefinition conflicts with an existing Attribute.
GraphQLAttributeDefinitionAlreadyExistsErrorBuilder Example to create an instance using the builder pattern
Returned when the name of the AttributeDefinition conflicts with an existing Attribute.
 
Returned when the type is different for an AttributeDefinition using the same name in multiple Product Types.
GraphQLAttributeDefinitionTypeConflictErrorBuilder Example to create an instance using the builder pattern
Returned when the type is different for an AttributeDefinition using the same name in multiple Product Types.
 
Returned when an AttributeDefinition does not exist for an Attribute name.
GraphQLAttributeNameDoesNotExistErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute name.
 
Returned when a server-side problem is caused by scaling infrastructure resources.
GraphQLBadGatewayErrorBuilder Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
 
Returned when the request conflicts with the current state of the involved resources.
GraphQLConcurrentModificationErrorBuilder Example to create an instance using the builder pattern
Returned when the request conflicts with the current state of the involved resources.
 
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
GraphQLCountryNotConfiguredInStoreErrorBuilder Example to create an instance using the builder pattern
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
 
Returned when the Cart contains a Discount Code with a DiscountCodeState other than MatchesCart.
GraphQLDiscountCodeNonApplicableErrorBuilder Example to create an instance using the builder pattern
Returned when the Cart contains a Discount Code with a DiscountCodeState other than MatchesCart.
 
Returned when the Unique AttributeConstraint criteria are not met during an Update Product request.
GraphQLDuplicateAttributeValueErrorBuilder Example to create an instance using the builder pattern
Returned when the Unique AttributeConstraint criteria are not met during an Update Product request.
 
Returned when the CombinationUnique AttributeConstraint criteria are not met during an Update Product request.
GraphQLDuplicateAttributeValuesErrorBuilder Example to create an instance using the builder pattern
Returned when the CombinationUnique AttributeConstraint criteria are not met during an Update Product request.
 
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
GraphQLDuplicateEnumValuesErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
 
Returned when a field value conflicts with an existing value causing a duplicate.
GraphQLDuplicateFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value causing a duplicate.
 
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
GraphQLDuplicateFieldWithConflictingResourceErrorBuilder Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
 
Returned when a Price key conflicts with an existing key.
GraphQLDuplicatePriceKeyErrorBuilder Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
 
Returned when a Price scope conflicts with an existing one during an Update Product request.
GraphQLDuplicatePriceScopeErrorBuilder Example to create an instance using the builder pattern
Returned when a Price scope conflicts with an existing one during an Update Product request.
 
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
GraphQLDuplicateStandalonePriceScopeErrorBuilder Example to create an instance using the builder pattern
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
 
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
GraphQLDuplicateVariantValuesErrorBuilder Example to create an instance using the builder pattern
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
 
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
GraphQLEditPreviewFailedErrorBuilder Example to create an instance using the builder pattern
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
 
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
GraphQLEnumKeyAlreadyExistsErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
 
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
GraphQLEnumKeyDoesNotExistErrorBuilder Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
 
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
GraphQLEnumValueIsUsedErrorBuilder Example to create an instance using the builder pattern
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
 
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
GraphQLEnumValuesMustMatchErrorBuilder Example to create an instance using the builder pattern
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
 
GraphQLError Example to create an instance using the builder pattern
GraphQLErrorBuilder Example to create an instance using the builder pattern
GraphQLError
GraphQLErrorLocation Example to create an instance using the builder pattern
GraphQLErrorLocationBuilder Example to create an instance using the builder pattern
GraphQLErrorLocation
 
Represents a single error.
GraphQLErrorObjectBuilder
Represents a single error.
 
 
Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).
GraphQLExtensionBadResponseErrorBuilder Example to create an instance using the builder pattern
Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).
 
Returned when the API Extension does not respond within the time limit, or could not be reached.
GraphQLExtensionNoResponseErrorBuilder Example to create an instance using the builder pattern
Returned when the API Extension does not respond within the time limit, or could not be reached.
 
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
GraphQLExtensionPredicateEvaluationFailedErrorBuilder Example to create an instance using the builder pattern
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
 
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
GraphQLExtensionUpdateActionsFailedErrorBuilder Example to create an instance using the builder pattern
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
 
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).
GraphQLExternalOAuthFailedErrorBuilder Example to create an instance using the builder pattern
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).
 
Returned when the requested feature was removed.
GraphQLFeatureRemovedErrorBuilder Example to create an instance using the builder pattern
Returned when the requested feature was removed.
 
Returned when a server-side problem occurs.
GraphQLGeneralErrorBuilder Example to create an instance using the builder pattern
Returned when a server-side problem occurs.
 
GraphQLInsufficientScopeError Example to create an instance using the builder pattern
GraphQLInsufficientScopeErrorBuilder Example to create an instance using the builder pattern
GraphQLInsufficientScopeError
 
Returned when certain API-specific constraints were not met.
GraphQLInternalConstraintViolatedErrorBuilder Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
 
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
GraphQLInvalidCredentialsErrorBuilder Example to create an instance using the builder pattern
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
 
Returned when the current password of the Customer does not match.
GraphQLInvalidCurrentPasswordErrorBuilder Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
 
Returned when a field has an invalid value.
GraphQLInvalidFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a field has an invalid value.
 
Returned when an invalid input has been sent.
GraphQLInvalidInputErrorBuilder Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
 
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
GraphQLInvalidItemShippingDetailsErrorBuilder Example to create an instance using the builder pattern
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
 
Returned when an invalid JSON input has been sent.
GraphQLInvalidJsonInputErrorBuilder Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
 
Returned when the resources involved in the request are not in a valid state for the operation.
GraphQLInvalidOperationErrorBuilder Example to create an instance using the builder pattern
Returned when the resources involved in the request are not in a valid state for the operation.
 
GraphQLInvalidSubjectError Example to create an instance using the builder pattern
GraphQLInvalidSubjectErrorBuilder Example to create an instance using the builder pattern
GraphQLInvalidSubjectError
 
GraphQLInvalidTokenError Example to create an instance using the builder pattern
GraphQLInvalidTokenErrorBuilder Example to create an instance using the builder pattern
GraphQLInvalidTokenError
 
Returned when a language cannot be removed from a Project as it is being used by a Store.
GraphQLLanguageUsedInStoresErrorBuilder Example to create an instance using the builder pattern
Returned when a language cannot be removed from a Project as it is being used by a Store.
 
Returned when the Product Variant does not have a Price according to the Product priceMode value for a selected currency, country, Customer Group, or Channel.
GraphQLMatchingPriceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the Product Variant does not have a Price according to the Product priceMode value for a selected currency, country, Customer Group, or Channel.
 
Returned when a resource type cannot be created as it has reached its limits.
GraphQLMaxResourceLimitExceededErrorBuilder Example to create an instance using the builder pattern
Returned when a resource type cannot be created as it has reached its limits.
 
Returned when one of the following states occur:
GraphQLMissingRoleOnChannelErrorBuilder Example to create an instance using the builder pattern
Returned when one of the following states occur:
 
Returned when the Tax Category of at least one of the lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.
GraphQLMissingTaxRateForCountryErrorBuilder Example to create an instance using the builder pattern
Returned when the Tax Category of at least one of the lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.
 
Returned when a Money operation overflows the 64-bit integer range.
GraphQLMoneyOverflowErrorBuilder Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
 
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
GraphQLNoMatchingProductDiscountFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
 
Returned when the Project-specific category recommendations feature is not enabled for the Project.
GraphQLNotEnabledErrorBuilder Example to create an instance using the builder pattern
Returned when the Project-specific category recommendations feature is not enabled for the Project.
 
Returned when the requested resource was not found.
GraphQLObjectNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the requested resource was not found.
 
Returned when some of the Line Items are out of stock at the time of placing an Order.
GraphQLOutOfStockErrorBuilder Example to create an instance using the builder pattern
Returned when some of the Line Items are out of stock at the time of placing an Order.
 
Returned when the service is having trouble handling the load.
GraphQLOverCapacityErrorBuilder Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
 
Returned when a given Price validity period conflicts with an existing one.
GraphQLOverlappingStandalonePriceValidityErrorBuilder Example to create an instance using the builder pattern
Returned when a given Price validity period conflicts with an existing one.
 
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
GraphQLPendingOperationErrorBuilder Example to create an instance using the builder pattern
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
 
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
GraphQLPriceChangedErrorBuilder Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
 
Returned when a Product is not assigned to the Product Selection.
GraphQLProductAssignmentMissingErrorBuilder Example to create an instance using the builder pattern
Returned when a Product is not assigned to the Product Selection.
 
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
GraphQLProductPresentWithDifferentVariantSelectionErrorBuilder Example to create an instance using the builder pattern
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
 
Returned when the languages set for a Store are not supported by the Project.
GraphQLProjectNotConfiguredForLanguagesErrorBuilder Example to create an instance using the builder pattern
Returned when the languages set for a Store are not supported by the Project.
 
GraphQLQueryComplexityLimitExceededError Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededErrorBuilder Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededError
 
Returned when the query times out.
GraphQLQueryTimedOutErrorBuilder Example to create an instance using the builder pattern
Returned when the query times out.
 
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
GraphQLReferencedResourceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
 
Returned when a resource cannot be deleted because it is being referenced by another resource.
GraphQLReferenceExistsErrorBuilder Example to create an instance using the builder pattern
Returned when a resource cannot be deleted because it is being referenced by another resource.
 
GraphQLRequest Example to create an instance using the builder pattern
GraphQLRequestBuilder Example to create an instance using the builder pattern
GraphQLRequest
 
Returned when a value is not defined for a required field.
GraphQLRequiredFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
 
Returned when the resource addressed by the request URL does not exist.
GraphQLResourceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the resource addressed by the request URL does not exist.
 
Returned when the resource exceeds the maximum allowed size of 16 MB.
GraphQLResourceSizeLimitExceededErrorBuilder Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
 
GraphQLResponse Example to create an instance using the builder pattern
GraphQLResponseBuilder Example to create an instance using the builder pattern
GraphQLResponse
 
Returned when the indexing of Product information is deactivated in a Project.
GraphQLSearchDeactivatedErrorBuilder Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
 
Returned when a search query could not be completed due to an unexpected failure.
GraphQLSearchExecutionFailureErrorBuilder Example to create an instance using the builder pattern
Returned when a search query could not be completed due to an unexpected failure.
 
Returned when a search facet path could not be found.
GraphQLSearchFacetPathNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
 
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
GraphQLSearchIndexingInProgressErrorBuilder Example to create an instance using the builder pattern
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
 
Returned when a Discount predicate or API Extension predicate is not semantically correct.
GraphQLSemanticErrorErrorBuilder Example to create an instance using the builder pattern
Returned when a Discount predicate or API Extension predicate is not semantically correct.
 
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
GraphQLShippingMethodDoesNotMatchCartErrorBuilder Example to create an instance using the builder pattern
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
 
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
GraphQLSyntaxErrorErrorBuilder Example to create an instance using the builder pattern
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
 
GraphQLVariablesMap Example to create an instance using the builder pattern
GraphQLVariablesMapBuilder Example to create an instance using the builder pattern
GraphQLVariablesMap
 
The HandlerStack is used to execute the middlewares in order and transfer the request using the specified HttpHandler
The helper methods simplify the use of our SDK.
Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.
HighPrecisionMoney Example to create an instance using the builder pattern
HighPrecisionMoneyBuilder Example to create an instance using the builder pattern
HighPrecisionMoneyBuilder Example to create an instance using the builder pattern
Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.
HighPrecisionMoneyDraftBuilder Example to create an instance using the builder pattern
Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.
 
Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.
HighPrecisionMoney
 
Deprecated.
 
 
Hit Example to create an instance using the builder pattern
HitBuilder Example to create an instance using the builder pattern
Hit
 
 
Interface to supply a HTTP client implementation specified by a ServiceLoader
We recommend an encrypted HTTPS connection for production setups.
HttpDestinationAuthentication Example to create a subtype instance using the builder pattern
HttpDestinationAuthenticationBuilder
HttpDestinationAuthentication
 
HttpDestinationBuilder Example to create an instance using the builder pattern
We recommend an encrypted HTTPS connection for production setups.
 
Exception which is thrown by HttpAsyncClient.
The HttpExceptionFactory creates exceptions based on the HTTP status code returned by the ApiHttpResponse.
Handler to execute the given request using a HTTP client
 
an object identifiable by an ID
Image Example to create an instance using the builder pattern
Image Example to create an instance using the builder pattern
An Image uploaded to commercetools Composable Commerce is stored in a Content Delivery Network and it's available in several pre-defined sizes.
ImageBuilder Example to create an instance using the builder pattern
ImageBuilder Example to create an instance using the builder pattern
ImageBuilder Example to create an instance using the builder pattern
ImageDimensions Example to create an instance using the builder pattern
ImageDimensions Example to create an instance using the builder pattern
ImageDimensionsBuilder Example to create an instance using the builder pattern
ImageDimensionsBuilder Example to create an instance using the builder pattern
ImageDimensions
ImageDimensions
 
Image
Image
An Image uploaded to commercetools Composable Commerce is stored in a Content Delivery Network and it's available in several pre-defined sizes.
 
ImageSearchConfigRequest Example to create an instance using the builder pattern
ImageSearchConfigRequestBuilder Example to create an instance using the builder pattern
ImageSearchConfigRequest
ImageSearchConfigResponse Example to create an instance using the builder pattern
ImageSearchConfigResponseBuilder Example to create an instance using the builder pattern
ImageSearchConfigResponse
ImageSearchConfigStatus
possible values of ImageSearchConfigStatus
ImageSearchConfigUpdateAction Example to create a subtype instance using the builder pattern
ImageSearchConfigUpdateActionBuilder
ImageSearchConfigUpdateAction
Response format from image search endpoint.
ImageSearchResponseBuilder Example to create an instance using the builder pattern
Response format from image search endpoint.
Deprecated.
Module to configure the default jackson ObjectMapper e.g.
 
 
 
Serves as the entry point of resources.
ImportContainerBuilder Example to create an instance using the builder pattern
The representation sent to the server when creating an ImportContainer.
ImportContainerDraftBuilder Example to create an instance using the builder pattern
The representation sent to the server when creating an ImportContainer.
Serves as the entry point of resources.
PagedQueryResult for ImportContainers.
ImportContainerPagedResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult for ImportContainers.
The representation sent to the server when updating an import container.
ImportContainerUpdateDraftBuilder Example to create an instance using the builder pattern
The representation sent to the server when updating an import container.
 
Import Operation describes the import status of a specific resource.
ImportOperationBuilder Example to create an instance using the builder pattern
Import Operation describes the import status of a specific resource.
PagedQueryResult for Import Operations.
ImportOperationPagedResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult for Import Operations.
Describes the validation state of a newly created ImportOperation.
possible values of ImportOperationState
ImportOperationStatus Example to create an instance using the builder pattern
ImportOperationStatusBuilder Example to create an instance using the builder pattern
ImportOperationStatus
An import request batches multiple import resources of the same import resource type for processing by an import container.
ImportRequestBuilder
An import request batches multiple import resources of the same import resource type for processing by an import container.
A representation of the resource to import.
ImportResourceBuilder Example to create an instance using the builder pattern
A representation of the resource to import.
The resource types that can be imported.
possible values of ImportResourceType
A list of the ID's and validation statuses of newly created ImportOperations.
ImportResponseBuilder Example to create an instance using the builder pattern
A list of the ID's and validation statuses of newly created ImportOperations.
Describes the status of an ImportContainer by the number of resources in each Processing State.
ImportSummaryBuilder Example to create an instance using the builder pattern
Describes the status of an ImportContainer by the number of resources in each Processing State.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
 
InheritedAssociate Example to create an instance using the builder pattern
InheritedAssociateBuilder Example to create an instance using the builder pattern
InheritedAssociate
 
InheritedAssociateRoleAssignment Example to create an instance using the builder pattern
InheritedAssociateRoleAssignmentBuilder Example to create an instance using the builder pattern
InheritedAssociateRoleAssignment
 
 
 
Table of content
  • Installation
    • Modules
    • Gradle
    • Maven
    • Troubleshooting
      • Spring Framework
InsufficientScopeError Example to create an instance using the builder pattern
InsufficientScopeError Example to create an instance using the builder pattern
InsufficientScopeErrorBuilder Example to create an instance using the builder pattern
InsufficientScopeErrorBuilder Example to create an instance using the builder pattern
InsufficientScopeError
InsufficientScopeError
 
Returned when certain API-specific constraints were not met.
InternalConstraintViolatedErrorBuilder Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
 
Unified logger instance to perform logging only for configured logging levels.
Creates the InternalLogger instances for the specified request
Middleware instrumenting the InternalLogger
 
 
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
InvalidCredentialsError Example to create an instance using the builder pattern
InvalidCredentialsErrorBuilder Example to create an instance using the builder pattern
InvalidCredentialsErrorBuilder Example to create an instance using the builder pattern
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
InvalidCredentialsError
 
Returned when the current password of the Customer does not match.
InvalidCurrentPasswordErrorBuilder Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
 
Returned when a field has an invalid value.
A given field is not supported.
InvalidFieldErrorBuilder Example to create an instance using the builder pattern
InvalidFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a field has an invalid value.
A given field is not supported.
 
An invalid input has been sent to the service.
InvalidInputBuilder Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
InvalidInputErrorBuilder Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
 
An invalid input has been sent to the service.
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
InvalidItemShippingDetailsErrorBuilder Example to create an instance using the builder pattern
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
 
An invalid JSON input has been sent to the service.
InvalidJsonInputBuilder Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
InvalidJsonInputErrorBuilder Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
 
An invalid JSON input has been sent to the service.
The resources in the request are not in the valid state for the operation.
InvalidOperationBuilder Example to create an instance using the builder pattern
Returned when the resources involved in the request are not in a valid state for the operation.
InvalidOperationErrorBuilder Example to create an instance using the builder pattern
Returned when the resources involved in the request are not in a valid state for the operation.
 
The resources in the request are not in the valid state for the operation.
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
InvalidScopeErrorBuilder Example to create an instance using the builder pattern
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
InvalidStateTransitionError Example to create an instance using the builder pattern
InvalidStateTransitionErrorBuilder Example to create an instance using the builder pattern
InvalidStateTransitionError
InvalidSubjectError Example to create an instance using the builder pattern
InvalidSubjectErrorBuilder Example to create an instance using the builder pattern
InvalidSubjectError
 
InvalidTokenError Example to create an instance using the builder pattern
InvalidTokenError Example to create an instance using the builder pattern
InvalidTokenErrorBuilder Example to create an instance using the builder pattern
InvalidTokenErrorBuilder Example to create an instance using the builder pattern
InvalidTokenError
InvalidTokenError
 
InventoryEntry Example to create an instance using the builder pattern
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
InventoryEntryAddQuantityActionBuilder Example to create an instance using the builder pattern
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
 
InventoryEntryBuilder Example to create an instance using the builder pattern
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
InventoryEntryChangeQuantityActionBuilder Example to create an instance using the builder pattern
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
 
Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
 
 
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
 
 
InventoryEntryDraft Example to create an instance using the builder pattern
InventoryEntryDraftBuilder Example to create an instance using the builder pattern
InventoryEntryDraft
 
InventoryEntry
 
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
InventoryEntryQuantitySetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
InventoryEntryQuantitySetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
 
 
 
Reference to an InventoryEntry.
InventoryEntryReferenceBuilder Example to create an instance using the builder pattern
Reference to an InventoryEntry.
 
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
InventoryEntryRemoveQuantityActionBuilder Example to create an instance using the builder pattern
Updates availableQuantity based on the new quantityOnStock and amount of active reservations.
 
ResourceIdentifier to an InventoryEntry.
InventoryEntryResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to an InventoryEntry.
 
InventoryEntrySetCustomFieldAction Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldActionBuilder Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldAction
 
InventoryEntrySetCustomTypeAction Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeActionBuilder Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeAction
 
InventoryEntrySetExpectedDeliveryAction Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryActionBuilder Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryAction
 
InventoryEntrySetKeyAction Example to create an instance using the builder pattern
InventoryEntrySetKeyActionBuilder Example to create an instance using the builder pattern
InventoryEntrySetKeyAction
 
InventoryEntrySetRestockableInDaysAction Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysActionBuilder Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysAction
 
If an entry with the same sku and supplyChannel already exists, an DuplicateField error is returned.
InventoryEntrySetSupplyChannelActionBuilder Example to create an instance using the builder pattern
If an entry with the same sku and supplyChannel already exists, an DuplicateField error is returned.
 
InventoryEntryUpdate Example to create an instance using the builder pattern
InventoryEntryUpdateAction Example to create a subtype instance using the builder pattern
InventoryEntryUpdateActionBuilder
InventoryEntryUpdateAction
 
InventoryEntryUpdateBuilder Example to create an instance using the builder pattern
InventoryEntryUpdate
 
The data representation for an Inventory to be imported that is persisted as a Inventory in the Project.
InventoryImportBuilder Example to create an instance using the builder pattern
The data representation for an Inventory to be imported that is persisted as a Inventory in the Project.
The request body to import Inventories.
InventoryImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Inventories.
Indicates how Line Items in a Cart are tracked.
Maps to Order.inventoryMode.
possible values of InventoryMode
possible values of InventoryMode
InventoryPagedQueryResponse Example to create an instance using the builder pattern
InventoryPagedQueryResponseBuilder Example to create an instance using the builder pattern
InventoryPagedQueryResponse
 
InventoryQuantityValue Example to create an instance using the builder pattern
InventoryQuantityValueBuilder Example to create an instance using the builder pattern
InventoryQuantityValue
 
 
ItemShippingDetails Example to create an instance using the builder pattern
ItemShippingDetails Example to create an instance using the builder pattern
ItemShippingDetailsBuilder Example to create an instance using the builder pattern
ItemShippingDetailsBuilder Example to create an instance using the builder pattern
For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
ItemShippingDetailsDraft Example to create an instance using the builder pattern
ItemShippingDetailsDraftBuilder Example to create an instance using the builder pattern
ItemShippingDetailsDraftBuilder Example to create an instance using the builder pattern
For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
ItemShippingDetailsDraft
 
ItemShippingDetails
ItemShippingDetails
 
Determines the address (as a reference to an address in itemShippingAddresses) and the quantity shipped to the address.
ItemShippingTarget Example to create an instance using the builder pattern
The item's shipping target.
ItemShippingTargetBuilder Example to create an instance using the builder pattern
ItemShippingTargetBuilder Example to create an instance using the builder pattern
ItemShippingTargetBuilder Example to create an instance using the builder pattern
Determines the address (as a reference to an address in itemShippingAddresses) and the quantity shipped to the address.
ItemShippingTarget
The item's shipping target.
 
ItemState Example to create an instance using the builder pattern
ItemState Example to create an instance using the builder pattern
The item's state.
ItemStateBuilder Example to create an instance using the builder pattern
ItemStateBuilder Example to create an instance using the builder pattern
ItemStateBuilder Example to create an instance using the builder pattern
ItemState
ItemState
The item's state.
 
 
 
Class with methods to customize the JSON serialization/deserialization
 
A KeyReference represents a loose reference to another resource in the same Project identified by the resource's key field.
KeyReference Example to create an instance using the builder pattern
References a resource by key.
KeyReferenceBuilder
KeyReferenceBuilder Example to create an instance using the builder pattern
KeyReferenceBuilder
A KeyReference represents a loose reference to another resource in the same Project identified by the resource's key field.
KeyReference
References a resource by key.
 
Provides descriptive information specific to the resource.
LabelBuilder
Provides descriptive information specific to the resource.
Returned when a language cannot be removed from a Project as it is being used by a Store.
LanguageUsedInStoresErrorBuilder Example to create an instance using the builder pattern
Returned when a language cannot be removed from a Project as it is being used by a Store.
 
Present on resources modified after 1 February 2019 except for events not tracked.
LastModifiedByBuilder Example to create an instance using the builder pattern
Present on resources modified after 1 February 2019 except for events not tracked.
 
The representation of a Line Item in a Cart.
LineItem Example to create an instance using the builder pattern
LineItemBuilder Example to create an instance using the builder pattern
LineItemBuilder Example to create an instance using the builder pattern
For Product Variant identification, either the productId and variantId, or sku must be provided.
LineItemDraftBuilder Example to create an instance using the builder pattern
For Product Variant identification, either the productId and variantId, or sku must be provided.
 
The representation of a Line Item in a Cart.
LineItem
LineItemImportDraft Example to create an instance using the builder pattern
Represents an individual Line Item in an Order.
LineItemImportDraftBuilder Example to create an instance using the builder pattern
LineItemImportDraftBuilder Example to create an instance using the builder pattern
LineItemImportDraft
Represents an individual Line Item in an Order.
 
Indicates how a Line Item is added to a Cart.
possible values of LineItemMode
LineItemPrice Example to create an instance using the builder pattern
LineItemPriceBuilder Example to create an instance using the builder pattern
LineItemPrice
This mode indicates how the price is set for the Line Item.
possible values of LineItemPriceMode
LineItemProductVariantImportDraft Example to create an instance using the builder pattern
LineItemProductVariantImportDraftBuilder Example to create an instance using the builder pattern
LineItemProductVariantImportDraft
 
LineItemReturnItem Example to create an instance using the builder pattern
LineItemReturnItemBuilder Example to create an instance using the builder pattern
LineItemReturnItem
 
Generated after a successful Transition Line Item State update action.
LineItemStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition Line Item State update action.
Generated after a successful Transition Line Item State update action.
LineItemStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition Line Item State update action.
 
 
serializes a LocalDate to DateTimeFormatter.ISO_DATE format
LocaleprojectingTrait
This type represents an attribute whose value is a localized enum.
LocalizableEnumAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized enum.
This type represents an attribute whose value is a localized enum.
LocalizableEnumSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized enum.
This type represents an attribute whose value is a localized text.
LocalizableTextAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized text.
This type represents an attribute whose value is a localized text.
LocalizableTextSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized text.
A field with a localized enum value.
LocalizedEnumFieldBuilder Example to create an instance using the builder pattern
A field with a localized enum value.
A field with a localized enum set value.
LocalizedEnumSetFieldBuilder Example to create an instance using the builder pattern
A field with a localized enum set value.
LocalizedEnumValue Example to create an instance using the builder pattern
LocalizedEnumValue Example to create an instance using the builder pattern
LocalizedEnumValueBuilder Example to create an instance using the builder pattern
LocalizedEnumValueBuilder Example to create an instance using the builder pattern
LocalizedEnumValue
LocalizedEnumValue
LocalizedLabel Example to create an instance using the builder pattern
LocalizedLabelBuilder Example to create an instance using the builder pattern
LocalizedLabel
A localized string is a object where the keys are Locales (HTTP API: ISO language tags), and the values are the corresponding strings used for that language.
LocalizedString Example to create an instance using the builder pattern
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
LocalizedString Example to create an instance using the builder pattern
Builder to create a LocalizedString
LocalizedStringBuilder Example to create an instance using the builder pattern
LocalizedStringBuilder Example to create an instance using the builder pattern
LocalizedStringBuilder Example to create an instance using the builder pattern
Entry of for a LocalizedString
A field with a localized string value.
LocalizedStringFieldBuilder Example to create an instance using the builder pattern
A field with a localized string value.
LocalizedString implementation
LocalizedString
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
LocalizedString
 
A field with a localized string set value.
LocalizedStringSetFieldBuilder Example to create an instance using the builder pattern
A field with a localized string set value.
serializes a LocalTime to DateTimeFormatter.ISO_TIME format
A geographical location representing a country and optionally a state within this country.
Shape of the value for addLocation and removeLocation actions
LocationBuilder Example to create an instance using the builder pattern
LocationBuilder Example to create an instance using the builder pattern
A geographical location representing a country and optionally a state within this country.
Shape of the value for addLocation and removeLocation actions
 
 
 
accessor interface for map objects like attributes or custom fields
Returned when the Product Variant does not have a Price according to the Product priceMode value for a selected currency, country, Customer Group, or Channel.
MatchingPriceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the Product Variant does not have a Price according to the Product priceMode value for a selected currency, country, Customer Group, or Channel.
 
Returned when a resource type cannot be created as it has reached its limits.
MaxResourceLimitExceededErrorBuilder Example to create an instance using the builder pattern
Returned when a resource type cannot be created as it has reached its limits.
 
 
Base representation of a Message containing common fields to all Message Types.
MessageBuilder
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
This payload is sent for a MessageSubscription.
MessageDeliveryPayloadBuilder Example to create an instance using the builder pattern
This payload is sent for a MessageSubscription.
 
Base representation of a Message containing common fields to all Message Types.
PagedQueryResult with results containing an array of Message.
MessagePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Message.
 
MessagePayload Example to create a subtype instance using the builder pattern
MessagePayloadBuilder
MessagePayload
 
 
Holds the configuration for the Messages Query feature for the Project.
MessagesConfigurationBuilder Example to create an instance using the builder pattern
Defines the configuration for the Messages Query feature for the Project.
MessagesConfigurationDraftBuilder Example to create an instance using the builder pattern
Defines the configuration for the Messages Query feature for the Project.
 
Holds the configuration for the Messages Query feature for the Project.
 
For supported resources and message types, see Message Types.
MessageSubscriptionBuilder Example to create an instance using the builder pattern
For supported resources and message types, see Message Types.
 
Resource types supported by MessageSubscriptions:
possible values of MessageSubscriptionResourceTypeId
Interface for resources with meta attributes
MethodTaxedPrice Example to create an instance using the builder pattern
MethodTaxedPriceBuilder Example to create an instance using the builder pattern
MethodTaxedPrice
 
MethodTaxRate Example to create an instance using the builder pattern
MethodTaxRateBuilder Example to create an instance using the builder pattern
MethodTaxRate
 
Interface for a HTTP middleware used to modify a request and the response
Deprecated.
functionality now available using the ClientBuilder
Table of content
  • Middlewares
    • ErrorMiddleware
    • OAuthMiddleware
    • RetryMiddleware
    • ConcurrentModificationMiddleware
    • UserAgentMiddleware
    • AcceptGZipMiddleware
    • InternalLoggerMiddleware
Returned when one of the following states occur:
MissingRoleOnChannelErrorBuilder Example to create an instance using the builder pattern
Returned when one of the following states occur:
 
Returned when the Tax Category of at least one of the lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.
MissingTaxRateForCountryErrorBuilder Example to create an instance using the builder pattern
Returned when the Tax Category of at least one of the lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.
 
 
Deprecated.
use MLApiRootFactory instead
 
 
 
Information about the user or API Client who performed the change.
ModifiedByBuilder Example to create an instance using the builder pattern
Information about the user or API Client who performed the change.
 
Interface to supply a Jackson SimpleModule specified by a ServiceLoader
conversion methods for Money classes
 
 
Draft type that stores amounts in cent precision for the specified currency.
Money Example to create an instance using the builder pattern
Money Example to create an instance using the builder pattern
Money Example to create an instance using the builder pattern
This type represents an attribute whose value is a money object.
MoneyAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a money object.
MoneyBuilder Example to create an instance using the builder pattern
MoneyBuilder Example to create an instance using the builder pattern
MoneyBuilder Example to create an instance using the builder pattern
MoneyBuilder Example to create an instance using the builder pattern
A field with a money value.
MoneyFieldBuilder Example to create an instance using the builder pattern
A field with a money value.
Draft type that stores amounts in cent precision for the specified currency.
Money
Money
Money
Returned when a Money operation overflows the 64-bit integer range.
MoneyOverflowErrorBuilder Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
 
 
This type represents an attribute whose value is a set of money objects.
MoneySetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of money objects.
A field with a money set value.
MoneySetFieldBuilder Example to create an instance using the builder pattern
A field with a money set value.
MoneyType supports two different values, one for amounts in cent precision and another one for sub-cent amounts up to 20 fraction digits.
MoneyType
MoneyType
possible values of MoneyType
possible values of MoneyType
possible values of MoneyType
Utility methods to convert from MonetaryAmount to Money and vice versa
Change triggered by the Move image to position update action.
MoveImageToPositionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Move image to position update action.
This Discount target is similar to MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.
MultiBuyCustomLineItemsTargetBuilder Example to create an instance using the builder pattern
This Discount target is similar to MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.
 
MultiBuyLineItemsTarget Example to create an instance using the builder pattern
MultiBuyLineItemsTargetBuilder Example to create an instance using the builder pattern
MultiBuyLineItemsTarget
 
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
MyBusinessUnitAddAddressActionBuilder Example to create an instance using the builder pattern
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
 
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
MyBusinessUnitAddBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
 
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
MyBusinessUnitAddShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
 
MyBusinessUnitAssociateDraft Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraftBuilder Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraft
 
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
MyBusinessUnitChangeAddressActionBuilder Example to create an instance using the builder pattern
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
 
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
MyBusinessUnitChangeAssociateActionBuilder Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
 
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
MyBusinessUnitChangeNameActionBuilder Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
 
Changing the parent of a Business Unit generates a BusinessUnitParentUnitChanged Message.
MyBusinessUnitChangeParentUnitActionBuilder Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentUnitChanged Message.
 
MyBusinessUnitDraft Example to create a subtype instance using the builder pattern
MyBusinessUnitDraftBuilder
MyBusinessUnitDraft
 
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
MyBusinessUnitRemoveAddressActionBuilder Example to create an instance using the builder pattern
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
 
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
MyBusinessUnitRemoveAssociateActionBuilder Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
 
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
MyBusinessUnitRemoveBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
 
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
MyBusinessUnitRemoveShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
 
MyBusinessUnitSetAddressCustomFieldAction Example to create an instance using the builder pattern
MyBusinessUnitSetAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
MyBusinessUnitSetAddressCustomFieldAction
 
MyBusinessUnitSetAddressCustomTypeAction Example to create an instance using the builder pattern
MyBusinessUnitSetAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
MyBusinessUnitSetAddressCustomTypeAction
 
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
MyBusinessUnitSetContactEmailActionBuilder Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
 
MyBusinessUnitSetCustomFieldAction Example to create an instance using the builder pattern
MyBusinessUnitSetCustomFieldActionBuilder Example to create an instance using the builder pattern
MyBusinessUnitSetCustomFieldAction
 
MyBusinessUnitSetCustomTypeAction Example to create an instance using the builder pattern
MyBusinessUnitSetCustomTypeActionBuilder Example to create an instance using the builder pattern
MyBusinessUnitSetCustomTypeAction
 
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
MyBusinessUnitSetDefaultBillingAddressActionBuilder Example to create an instance using the builder pattern
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
 
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
MyBusinessUnitSetDefaultShippingAddressActionBuilder Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
 
MyBusinessUnitUpdate Example to create an instance using the builder pattern
MyBusinessUnitUpdateAction Example to create a subtype instance using the builder pattern
MyBusinessUnitUpdateActionBuilder
MyBusinessUnitUpdateAction
 
MyBusinessUnitUpdateBuilder Example to create an instance using the builder pattern
MyBusinessUnitUpdate
 
Adds a DiscountCode to the Cart to activate the related CartDiscounts.
MyCartAddDiscountCodeActionBuilder Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related CartDiscounts.
 
Adds an address to a Cart when shipping to multiple addresses is desired.
MyCartAddItemShippingAddressActionBuilder Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
 
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
MyCartAddLineItemActionBuilder Example to create an instance using the builder pattern
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
 
MyCartAddPaymentAction Example to create an instance using the builder pattern
MyCartAddPaymentActionBuilder Example to create an instance using the builder pattern
MyCartAddPaymentAction
 
To override the shipping details, see Set LineItemShippingDetails.
MyCartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder pattern
To override the shipping details, see Set LineItemShippingDetails.
 
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
MyCartChangeLineItemQuantityActionBuilder Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
 
When External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed. When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress. Example to create an instance using the builder pattern
MyCartChangeTaxModeActionBuilder Example to create an instance using the builder pattern
When External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed. When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress.
 
The customerId is determined by a password flow token and automatically set on the resulting Cart.
MyCartDraftBuilder Example to create an instance using the builder pattern
The customerId is determined by a password flow token and automatically set on the resulting Cart.
 
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
MyCartRecalculateActionBuilder Example to create an instance using the builder pattern
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
 
MyCartRemoveDiscountCodeAction Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeActionBuilder Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeAction
 
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
MyCartRemoveItemShippingAddressActionBuilder Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
 
The LineItem price is updated as described in LineItem Price selection.
MyCartRemoveLineItemActionBuilder Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
 
MyCartRemovePaymentAction Example to create an instance using the builder pattern
MyCartRemovePaymentActionBuilder Example to create an instance using the builder pattern
MyCartRemovePaymentAction
 
MyCartSetBillingAddressAction Example to create an instance using the builder pattern
MyCartSetBillingAddressActionBuilder Example to create an instance using the builder pattern
MyCartSetBillingAddressAction
 
Updates the Business Unit on the Cart.
MyCartSetBusinessUnitActionBuilder Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
 
Setting the country can lead to changes in the LineItem prices.
MyCartSetCountryActionBuilder Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
 
MyCartSetCustomerEmailAction Example to create an instance using the builder pattern
MyCartSetCustomerEmailActionBuilder Example to create an instance using the builder pattern
MyCartSetCustomerEmailAction
 
MyCartSetCustomFieldAction Example to create an instance using the builder pattern
MyCartSetCustomFieldActionBuilder Example to create an instance using the builder pattern
MyCartSetCustomFieldAction
 
MyCartSetCustomTypeAction Example to create an instance using the builder pattern
MyCartSetCustomTypeActionBuilder Example to create an instance using the builder pattern
MyCartSetCustomTypeAction
 
Number of days after which a Cart with Active CartState is deleted since its last modification.
MyCartSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder pattern
Number of days after which a Cart with Active CartState is deleted since its last modification.
 
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
MyCartSetDirectDiscountsActionBuilder Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
 
MyCartSetLineItemCustomFieldAction Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldAction
 
MyCartSetLineItemCustomTypeAction Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeAction
 
Setting a distribution channel for a LineItem can lead to an updated price as described in LineItem Price selection.
MyCartSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder pattern
Setting a distribution channel for a LineItem can lead to an updated price as described in LineItem Price selection.
 
MyCartSetLineItemShippingDetailsAction Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsAction
 
Performing this action has no impact on inventory that should be reserved.
MyCartSetLineItemSupplyChannelActionBuilder Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
 
MyCartSetLocaleAction Example to create an instance using the builder pattern
MyCartSetLocaleActionBuilder Example to create an instance using the builder pattern
MyCartSetLocaleAction
 
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
MyCartSetShippingAddressActionBuilder Example to create an instance using the builder pattern
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
 
To set the Cart's Shipping Method the Cart must have the Single ShippingMode and a shippingAddress.
MyCartSetShippingMethodActionBuilder Example to create an instance using the builder pattern
To set the Cart's Shipping Method the Cart must have the Single ShippingMode and a shippingAddress.
 
MyCartUpdate Example to create an instance using the builder pattern
MyCartUpdateAction Example to create a subtype instance using the builder pattern
MyCartUpdateActionBuilder
MyCartUpdateAction
 
MyCartUpdateBuilder Example to create an instance using the builder pattern
MyCartUpdate
Updates an address in itemShippingAddresses by keeping the Address key.
MyCartUpdateItemShippingAddressActionBuilder Example to create an instance using the builder pattern
Updates an address in itemShippingAddresses by keeping the Address key.
 
 
Draft type to represent the top level of a business.
MyCompanyDraftBuilder Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
 
Adding an address to the Customer produces the CustomerAddressAdded Message.
MyCustomerAddAddressActionBuilder Example to create an instance using the builder pattern
Adding an address to the Customer produces the CustomerAddressAdded Message.
 
Adds an address from the addresses array to billingAddressIds.
MyCustomerAddBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Adds an address from the addresses array to billingAddressIds.
 
Adds an address from the addresses array to shippingAddressIds.
MyCustomerAddShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Adds an address from the addresses array to shippingAddressIds.
 
Changing an address of the Customer produces the CustomerAddressChanged Message.
MyCustomerChangeAddressActionBuilder Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
 
Changing the email of the Customer produces the CustomerEmailChanged Message.
MyCustomerChangeEmailActionBuilder Example to create an instance using the builder pattern
Changing the email of the Customer produces the CustomerEmailChanged Message.
 
MyCustomerChangePassword Example to create an instance using the builder pattern
MyCustomerChangePasswordBuilder Example to create an instance using the builder pattern
MyCustomerChangePassword
 
MyCustomerDraft Example to create an instance using the builder pattern
MyCustomerDraftBuilder Example to create an instance using the builder pattern
MyCustomerDraft
 
MyCustomerEmailVerify Example to create an instance using the builder pattern
MyCustomerEmailVerifyBuilder Example to create an instance using the builder pattern
MyCustomerEmailVerify
 
Removing an address of the Customer produces the CustomerAddressRemoved Message.
MyCustomerRemoveAddressActionBuilder Example to create an instance using the builder pattern
Removing an address of the Customer produces the CustomerAddressRemoved Message.
 
Removes an existing billing address from billingAddressesIds.
MyCustomerRemoveBillingAddressIdActionBuilder Example to create an instance using the builder pattern
Removes an existing billing address from billingAddressesIds.
 
Removes an existing shipping address from shippingAddressesIds.
MyCustomerRemoveShippingAddressIdActionBuilder Example to create an instance using the builder pattern
Removes an existing shipping address from shippingAddressesIds.
 
MyCustomerResetPassword Example to create an instance using the builder pattern
MyCustomerResetPasswordBuilder Example to create an instance using the builder pattern
MyCustomerResetPassword
 
Setting the companyName field on the Customer produces the CustomerCompanyNameSet Message.
MyCustomerSetCompanyNameActionBuilder Example to create an instance using the builder pattern
Setting the companyName field on the Customer produces the CustomerCompanyNameSet Message.
 
MyCustomerSetCustomFieldAction Example to create an instance using the builder pattern
MyCustomerSetCustomFieldActionBuilder Example to create an instance using the builder pattern
MyCustomerSetCustomFieldAction
 
MyCustomerSetCustomTypeAction Example to create an instance using the builder pattern
MyCustomerSetCustomTypeActionBuilder Example to create an instance using the builder pattern
MyCustomerSetCustomTypeAction
 
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
MyCustomerSetDateOfBirthActionBuilder Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
 
Sets the default billing address from addresses.
MyCustomerSetDefaultBillingAddressActionBuilder Example to create an instance using the builder pattern
Sets the default billing address from addresses.
 
Sets the default shipping address from addresses.
MyCustomerSetDefaultShippingAddressActionBuilder Example to create an instance using the builder pattern
Sets the default shipping address from addresses.
 
Setting the first name of the Customer produces the CustomerFirstNameSetMessage.
MyCustomerSetFirstNameActionBuilder Example to create an instance using the builder pattern
Setting the first name of the Customer produces the CustomerFirstNameSetMessage.
 
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
MyCustomerSetLastNameActionBuilder Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
 
MyCustomerSetLocaleAction Example to create an instance using the builder pattern
MyCustomerSetLocaleActionBuilder Example to create an instance using the builder pattern
MyCustomerSetLocaleAction
 
MyCustomerSetMiddleNameAction Example to create an instance using the builder pattern
MyCustomerSetMiddleNameActionBuilder Example to create an instance using the builder pattern
MyCustomerSetMiddleNameAction
 
MyCustomerSetSalutationAction Example to create an instance using the builder pattern
MyCustomerSetSalutationActionBuilder Example to create an instance using the builder pattern
MyCustomerSetSalutationAction
 
Setting the title of the Customer produces the CustomerTitleSetMessage.
MyCustomerSetTitleActionBuilder Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSetMessage.
 
MyCustomerSetVatIdAction Example to create an instance using the builder pattern
MyCustomerSetVatIdActionBuilder Example to create an instance using the builder pattern
MyCustomerSetVatIdAction
 
MyCustomerSignin Example to create an instance using the builder pattern
MyCustomerSigninBuilder Example to create an instance using the builder pattern
MyCustomerSignin
 
MyCustomerUpdate Example to create an instance using the builder pattern
MyCustomerUpdateAction Example to create a subtype instance using the builder pattern
MyCustomerUpdateActionBuilder
MyCustomerUpdateAction
 
MyCustomerUpdateBuilder Example to create an instance using the builder pattern
MyCustomerUpdate
 
Draft type to model divisions that are part of the Company or a higher-order Division.
MyDivisionDraftBuilder Example to create an instance using the builder pattern
Draft type to model divisions that are part of the Company or a higher-order Division.
 
For Product Variant identification, either the productId and variantId, or sku must be provided.
MyLineItemDraftBuilder Example to create an instance using the builder pattern
For Product Variant identification, either the productId and variantId, or sku must be provided.
 
When creating B2B Orders, the Customer must have the MyOrderFromCartDraft Permission.
MyOrderFromCartDraftBuilder Example to create an instance using the builder pattern
When creating B2B Orders, the Customer must have the MyOrderFromCartDraft Permission.
 
When creating B2B Orders, the Customer must have the MyOrderFromQuoteDraft Permission.
MyOrderFromQuoteDraftBuilder Example to create an instance using the builder pattern
When creating B2B Orders, the Customer must have the MyOrderFromQuoteDraft Permission.
 
MyPayment Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
MyPaymentAddTransactionActionBuilder Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
 
MyPaymentBuilder Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
MyPaymentChangeAmountPlannedActionBuilder Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
 
MyPaymentDraft Example to create an instance using the builder pattern
MyPaymentDraftBuilder Example to create an instance using the builder pattern
MyPaymentDraft
 
MyPayment
PagedQueryResult with results containing an array of MyPayment.
MyPaymentPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of MyPayment.
 
 
MyPaymentSetCustomFieldAction Example to create an instance using the builder pattern
MyPaymentSetCustomFieldActionBuilder Example to create an instance using the builder pattern
MyPaymentSetCustomFieldAction
 
MyPaymentSetMethodInfoInterfaceAction Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceActionBuilder Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceAction
 
MyPaymentSetMethodInfoMethodAction Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodActionBuilder Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodAction
 
MyPaymentSetMethodInfoNameAction Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameActionBuilder Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameAction
 
MyPaymentSetTransactionCustomFieldAction Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldActionBuilder Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldAction
 
MyPaymentUpdate Example to create an instance using the builder pattern
MyPaymentUpdateAction Example to create a subtype instance using the builder pattern
MyPaymentUpdateActionBuilder
MyPaymentUpdateAction
 
MyPaymentUpdateBuilder Example to create an instance using the builder pattern
MyPaymentUpdate
 
When accepting, declining, or renegotiating B2B Quotes, the Customer must have the AcceptMyQuotes, DeclineMyQuotes, or RenegotiateMyQuotes Permission, respectively.
MyQuoteChangeMyQuoteStateActionBuilder Example to create an instance using the builder pattern
When accepting, declining, or renegotiating B2B Quotes, the Customer must have the AcceptMyQuotes, DeclineMyQuotes, or RenegotiateMyQuotes Permission, respectively.
 
Transitions the quoteRequestState of the Quote Request to Cancelled.
MyQuoteRequestCancelActionBuilder Example to create an instance using the builder pattern
Transitions the quoteRequestState of the Quote Request to Cancelled.
 
MyQuoteRequestDraft Example to create an instance using the builder pattern
MyQuoteRequestDraftBuilder Example to create an instance using the builder pattern
MyQuoteRequestDraft
 
MyQuoteRequestUpdate Example to create an instance using the builder pattern
MyQuoteRequestUpdateAction Example to create a subtype instance using the builder pattern
MyQuoteRequestUpdateActionBuilder
MyQuoteRequestUpdateAction
 
MyQuoteRequestUpdateBuilder Example to create an instance using the builder pattern
MyQuoteRequestUpdate
 
QuoteStates that can be set using the Change My Quote State update action.
possible values of MyQuoteState
MyQuoteUpdate Example to create an instance using the builder pattern
MyQuoteUpdateAction Example to create a subtype instance using the builder pattern
MyQuoteUpdateActionBuilder
MyQuoteUpdateAction
 
MyQuoteUpdateBuilder Example to create an instance using the builder pattern
MyQuoteUpdate
 
MyShoppingListAddLineItemAction Example to create an instance using the builder pattern
MyShoppingListAddLineItemActionBuilder Example to create an instance using the builder pattern
MyShoppingListAddLineItemAction
 
MyShoppingListAddTextLineItemAction Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemActionBuilder Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemAction
 
MyShoppingListChangeLineItemQuantityAction Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityAction
 
MyShoppingListChangeLineItemsOrderAction Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderAction
 
MyShoppingListChangeNameAction Example to create an instance using the builder pattern
MyShoppingListChangeNameActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeNameAction
 
MyShoppingListChangeTextLineItemNameAction Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameAction
 
MyShoppingListChangeTextLineItemQuantityAction Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityAction
 
MyShoppingListChangeTextLineItemsOrderAction Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderActionBuilder Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderAction
 
A MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.
MyShoppingListDraftBuilder Example to create an instance using the builder pattern
A MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.
 
MyShoppingListRemoveLineItemAction Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemActionBuilder Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemAction
 
MyShoppingListRemoveTextLineItemAction Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemActionBuilder Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemAction
 
MyShoppingListSetCustomFieldAction Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldAction
 
MyShoppingListSetCustomTypeAction Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeAction
 
MyShoppingListSetDeleteDaysAfterLastModificationAction Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationAction
 
MyShoppingListSetDescriptionAction Example to create an instance using the builder pattern
MyShoppingListSetDescriptionActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetDescriptionAction
 
MyShoppingListSetLineItemCustomFieldAction Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldAction
 
MyShoppingListSetLineItemCustomTypeAction Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeAction
 
MyShoppingListSetTextLineItemCustomFieldAction Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldAction
 
MyShoppingListSetTextLineItemCustomTypeAction Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeAction
 
MyShoppingListSetTextLineItemDescriptionAction Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionActionBuilder Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionAction
 
MyShoppingListUpdate Example to create an instance using the builder pattern
MyShoppingListUpdateAction Example to create a subtype instance using the builder pattern
MyShoppingListUpdateActionBuilder
MyShoppingListUpdateAction
 
MyShoppingListUpdateBuilder Example to create an instance using the builder pattern
MyShoppingListUpdate
 
MyTransactionDraft Example to create an instance using the builder pattern
MyTransactionDraftBuilder Example to create an instance using the builder pattern
MyTransactionDraft
 
 
 
 
The NewRelicTelemetry middleware can be used to report outgoing request to commercetools to NewRelic.
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
NoMatchingProductDiscountFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
 
Returned when the Project-specific category recommendations feature is not enabled for the Project.
NotEnabledErrorBuilder Example to create an instance using the builder pattern
Returned when the Project-specific category recommendations feature is not enabled for the Project.
 
 
 
Middleware to convert a NotFoundException to a response with a null body value
This type represents an attribute whose value is a number.
NumberAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a number.
A field with a number value.
NumberFieldBuilder Example to create an instance using the builder pattern
A field with a number value.
This type represents an attribute whose value is a set of numbers.
NumberSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of numbers.
A field with a number value.
NumberSetFieldBuilder Example to create an instance using the builder pattern
A field with a number value.
Handler for retrieving an oauth authentication token
Middleware to add an oauth authentication header to requests
Default implementation for the OAuthMiddleware with automatic retry upon expired access
Returned when the requested resource was not found.
ObjectNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the requested resource was not found.
 
 
 
OperationStates Example to create an instance using the builder pattern
OperationStatesBuilder Example to create an instance using the builder pattern
OperationStates
Order Example to create an instance using the builder pattern
OrderAddDeliveryAction Example to create an instance using the builder pattern
OrderAddDeliveryActionBuilder Example to create an instance using the builder pattern
OrderAddDeliveryAction
 
OrderAddItemShippingAddressAction Example to create an instance using the builder pattern
OrderAddItemShippingAddressActionBuilder Example to create an instance using the builder pattern
OrderAddItemShippingAddressAction
 
OrderAddParcelToDeliveryAction Example to create an instance using the builder pattern
OrderAddParcelToDeliveryActionBuilder Example to create an instance using the builder pattern
OrderAddParcelToDeliveryAction
 
OrderAddPaymentAction Example to create an instance using the builder pattern
OrderAddPaymentActionBuilder Example to create an instance using the builder pattern
OrderAddPaymentAction
 
OrderAddReturnInfoAction Example to create an instance using the builder pattern
OrderAddReturnInfoActionBuilder Example to create an instance using the builder pattern
OrderAddReturnInfoAction
 
Generated after a successful Set Billing Address update action.
OrderBillingAddressSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Billing Address update action.
Generated after a successful Set Billing Address update action.
OrderBillingAddressSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Billing Address update action.
 
 
OrderBuilder Example to create an instance using the builder pattern
OrderChangeOrderStateAction Example to create an instance using the builder pattern
OrderChangeOrderStateActionBuilder Example to create an instance using the builder pattern
OrderChangeOrderStateAction
 
OrderChangePaymentStateAction Example to create an instance using the builder pattern
OrderChangePaymentStateActionBuilder Example to create an instance using the builder pattern
OrderChangePaymentStateAction
 
OrderChangeShipmentStateAction Example to create an instance using the builder pattern
OrderChangeShipmentStateActionBuilder Example to create an instance using the builder pattern
OrderChangeShipmentStateAction
 
Generated after a successful Create Order request.
OrderCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Order request.
Generated after a successful Create Order request.
OrderCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Order request.
 
 
Generated after a successful Set Customer Email update action.
OrderCustomerEmailSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Email update action.
Generated after a successful Set Customer Email update action.
OrderCustomerEmailSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Email update action.
 
 
Generated after a successful Set Customer Group update action.
OrderCustomerGroupSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
Generated after a successful Set Customer Group update action.
OrderCustomerGroupSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
 
 
Generated after a successful Set Customer Id update action.
OrderCustomerSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Id update action.
Generated after a successful Set Customer Id update action.
OrderCustomerSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Customer Id update action.
 
 
Generated after a successful Add Custom Line Item update action.
OrderCustomLineItemAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Custom Line Item update action.
Generated after a successful Add Custom Line Item update action.
OrderCustomLineItemAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Custom Line Item update action.
 
 
Generated after a successful recalculation of a Discount on a Custom Line Item.
OrderCustomLineItemDiscountSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Custom Line Item.
Generated after a successful recalculation of a Discount on a Custom Line Item.
OrderCustomLineItemDiscountSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Custom Line Item.
 
 
Generated after a successful Change Custom Line Item Quantity update action.
OrderCustomLineItemQuantityChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Custom Line Item Quantity update action.
Generated after a successful Change Custom Line Item Quantity update action.
OrderCustomLineItemQuantityChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Custom Line Item Quantity update action.
 
 
Generated after a successful Remove Custom Line Item update action.
OrderCustomLineItemRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Custom Line Item update action.
Generated after a successful Remove Custom Line Item update action.
OrderCustomLineItemRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Custom Line Item update action.
 
 
Generated after a successful Delete Order request.
OrderDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
Generated after a successful Delete Order request.
OrderDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
 
 
Generated after a successful Add Discount Code update action.
OrderDiscountCodeAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Discount Code update action.
Generated after a successful Add Discount Code update action.
OrderDiscountCodeAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Discount Code update action.
 
 
Generated after a successful Remove Discount Code update action.
OrderDiscountCodeRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Discount Code update action.
Generated after a successful Remove Discount Code update action.
OrderDiscountCodeRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Discount Code update action.
 
 
Generated after the DiscountCodeState changes due to a recalculation.
OrderDiscountCodeStateSetMessageBuilder Example to create an instance using the builder pattern
Generated after the DiscountCodeState changes due to a recalculation.
Generated after the DiscountCodeState changes due to a recalculation.
OrderDiscountCodeStateSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after the DiscountCodeState changes due to a recalculation.
 
 
OrderEdit Example to create an instance using the builder pattern
OrderEditAddStagedActionAction Example to create an instance using the builder pattern
OrderEditAddStagedActionActionBuilder Example to create an instance using the builder pattern
OrderEditAddStagedActionAction
 
OrderEditApplied Example to create an instance using the builder pattern
OrderEditAppliedBuilder Example to create an instance using the builder pattern
OrderEditApplied
Generated after a successfully applying an OrderEdit.
OrderEditAppliedMessageBuilder Example to create an instance using the builder pattern
Generated after a successfully applying an OrderEdit.
Generated after a successfully applying an OrderEdit.
OrderEditAppliedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successfully applying an OrderEdit.
 
 
 
OrderEditApply Example to create an instance using the builder pattern
OrderEditApplyBuilder Example to create an instance using the builder pattern
OrderEditApply
 
OrderEditBuilder Example to create an instance using the builder pattern
OrderEditDraft Example to create an instance using the builder pattern
OrderEditDraftBuilder Example to create an instance using the builder pattern
OrderEditDraft
 
OrderEdit
 
OrderEditNotProcessed Example to create an instance using the builder pattern
OrderEditNotProcessedBuilder Example to create an instance using the builder pattern
OrderEditNotProcessed
 
OrderEditPagedQueryResponse Example to create an instance using the builder pattern
OrderEditPagedQueryResponseBuilder Example to create an instance using the builder pattern
OrderEditPagedQueryResponse
 
OrderEditPreviewFailure Example to create an instance using the builder pattern
OrderEditPreviewFailureBuilder Example to create an instance using the builder pattern
OrderEditPreviewFailure
 
OrderEditPreviewSuccess Example to create an instance using the builder pattern
OrderEditPreviewSuccessBuilder Example to create an instance using the builder pattern
OrderEditPreviewSuccess
 
 
Reference to an OrderEdit.
OrderEditReferenceBuilder Example to create an instance using the builder pattern
Reference to an OrderEdit.
 
ResourceIdentifier to an OrderEdit.
OrderEditResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to an OrderEdit.
 
OrderEditResult Example to create a subtype instance using the builder pattern
OrderEditResultBuilder
OrderEditResult
 
OrderEditSetCommentAction Example to create an instance using the builder pattern
OrderEditSetCommentActionBuilder Example to create an instance using the builder pattern
OrderEditSetCommentAction
 
OrderEditSetCustomFieldAction Example to create an instance using the builder pattern
OrderEditSetCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderEditSetCustomFieldAction
 
OrderEditSetCustomTypeAction Example to create an instance using the builder pattern
OrderEditSetCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderEditSetCustomTypeAction
 
OrderEditSetKeyAction Example to create an instance using the builder pattern
OrderEditSetKeyActionBuilder Example to create an instance using the builder pattern
OrderEditSetKeyAction
 
OrderEditSetStagedActionsAction Example to create an instance using the builder pattern
OrderEditSetStagedActionsActionBuilder Example to create an instance using the builder pattern
OrderEditSetStagedActionsAction
 
OrderEditUpdate Example to create an instance using the builder pattern
OrderEditUpdateAction Example to create a subtype instance using the builder pattern
OrderEditUpdateActionBuilder
OrderEditUpdateAction
 
OrderEditUpdateBuilder Example to create an instance using the builder pattern
OrderEditUpdate
 
OrderExcerpt Example to create an instance using the builder pattern
OrderExcerptBuilder Example to create an instance using the builder pattern
OrderExcerpt
 
Order fields that needs to be added or updated.
OrderFieldBuilder Example to create an instance using the builder pattern
Order fields that needs to be added or updated.
OrderFromCartDraft Example to create an instance using the builder pattern
OrderFromCartDraftBuilder Example to create an instance using the builder pattern
OrderFromCartDraft
 
OrderFromQuoteDraft Example to create an instance using the builder pattern
OrderFromQuoteDraftBuilder Example to create an instance using the builder pattern
OrderFromQuoteDraft
 
Order
The data representation for an Order to be imported that is persisted as an Order in the Project.
OrderImportBuilder Example to create an instance using the builder pattern
OrderImportCustomLineItemStateAction Example to create an instance using the builder pattern
OrderImportCustomLineItemStateActionBuilder Example to create an instance using the builder pattern
OrderImportCustomLineItemStateAction
 
OrderImportDraft Example to create an instance using the builder pattern
OrderImportDraftBuilder Example to create an instance using the builder pattern
OrderImportDraft
 
Generated after a successful Order Import.
OrderImportedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Order Import.
Generated after a successful Order Import.
OrderImportedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Order Import.
 
 
The data representation for an Order to be imported that is persisted as an Order in the Project.
OrderImportLineItemStateAction Example to create an instance using the builder pattern
OrderImportLineItemStateActionBuilder Example to create an instance using the builder pattern
OrderImportLineItemStateAction
 
The request body to import Orders.
OrderImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Orders.
References an order by key.
OrderKeyReferenceBuilder Example to create an instance using the builder pattern
References an order by key.
OrderLabel Example to create an instance using the builder pattern
OrderLabelBuilder Example to create an instance using the builder pattern
OrderLabel
Interface to collect the common stuff between carts and orders.
Generated after a successful Add Line Item update action.
OrderLineItemAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Line Item update action.
Generated after a successful Add Line Item update action.
OrderLineItemAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Line Item update action.
 
 
Generated after a successful recalculation of a Discount on a Line Item.
OrderLineItemDiscountSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Line Item.
Generated after a successful recalculation of a Discount on a Line Item.
OrderLineItemDiscountSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Line Item.
 
 
Generated after a successful Set Line Item Distribution Channel update action.
OrderLineItemDistributionChannelSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Line Item Distribution Channel update action.
Generated after a successful Set Line Item Distribution Channel update action.
OrderLineItemDistributionChannelSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Line Item Distribution Channel update action.
 
 
Generated after a successful Remove Line Item update action.
OrderLineItemRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Line Item update action.
Generated after a successful Remove Line Item update action.
OrderLineItemRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Line Item update action.
 
 
OrderMessage Example to create an instance using the builder pattern
OrderMessage
OrderMessagePayload Example to create an instance using the builder pattern
OrderMessagePayload
 
 
 
OrderPagedQueryResponse Example to create an instance using the builder pattern
OrderPagedQueryResponseBuilder Example to create an instance using the builder pattern
OrderPagedQueryResponse
 
OrderPagedSearchResponse Example to create an instance using the builder pattern
OrderPagedSearchResponseBuilder Example to create an instance using the builder pattern
OrderPagedSearchResponse
 
Representation for an update of an Order.
OrderPatchImportBuilder Example to create an instance using the builder pattern
Representation for an update of an Order.
The request body to import OrderPatches.
OrderPatchImportRequestBuilder Example to create an instance using the builder pattern
The request body to import OrderPatches.
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
OrderPaymentAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
OrderPaymentAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
 
 
Generated after a successful Change Payment State update action.
OrderPaymentStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Payment State update action.
Generated after a successful Change Payment State update action.
OrderPaymentStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Payment State update action.
 
 
Generated after a successful Set PurchaseOrderNumber update action.
OrderPurchaseOrderNumberSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set PurchaseOrderNumber update action.
Generated after a successful Set PurchaseOrderNumber update action.
OrderPurchaseOrderNumberSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set PurchaseOrderNumber update action.
 
 
 
OrderReference Example to create an instance using the builder pattern
OrderReferenceBuilder Example to create an instance using the builder pattern
OrderReference
 
OrderRemoveDeliveryAction Example to create an instance using the builder pattern
OrderRemoveDeliveryActionBuilder Example to create an instance using the builder pattern
OrderRemoveDeliveryAction
 
OrderRemoveItemShippingAddressAction Example to create an instance using the builder pattern
OrderRemoveItemShippingAddressActionBuilder Example to create an instance using the builder pattern
OrderRemoveItemShippingAddressAction
 
OrderRemoveParcelFromDeliveryAction Example to create an instance using the builder pattern
OrderRemoveParcelFromDeliveryActionBuilder Example to create an instance using the builder pattern
OrderRemoveParcelFromDeliveryAction
 
OrderRemovePaymentAction Example to create an instance using the builder pattern
OrderRemovePaymentActionBuilder Example to create an instance using the builder pattern
OrderRemovePaymentAction
 
OrderResourceIdentifier Example to create an instance using the builder pattern
OrderResourceIdentifierBuilder Example to create an instance using the builder pattern
OrderResourceIdentifier
 
Generated after a successful Set Return Shipment State update action.
OrderReturnShipmentStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Return Shipment State update action.
Generated after a successful Set Return Shipment State update action.
OrderReturnShipmentStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Return Shipment State update action.
 
 
OrderSearchAndExpression Example to create an instance using the builder pattern
OrderSearchAndExpressionBuilder Example to create an instance using the builder pattern
OrderSearchAndExpression
 
OrderSearchAnyValue Example to create an instance using the builder pattern
OrderSearchAnyValueBuilder Example to create an instance using the builder pattern
OrderSearchAnyValue
 
OrderSearchCompoundExpression Example to create an instance using the builder pattern
OrderSearchCompoundExpressionBuilder Example to create an instance using the builder pattern
OrderSearchCompoundExpression
 
OrderSearchDateRangeExpression Example to create an instance using the builder pattern
OrderSearchDateRangeExpressionBuilder Example to create an instance using the builder pattern
OrderSearchDateRangeExpression
 
OrderSearchDateRangeValue Example to create an instance using the builder pattern
OrderSearchDateRangeValueBuilder Example to create an instance using the builder pattern
OrderSearchDateRangeValue
 
OrderSearchExactExpression Example to create an instance using the builder pattern
OrderSearchExactExpressionBuilder Example to create an instance using the builder pattern
OrderSearchExactExpression
 
OrderSearchExistsExpression Example to create an instance using the builder pattern
OrderSearchExistsExpressionBuilder Example to create an instance using the builder pattern
OrderSearchExistsExpression
 
OrderSearchFilterExpression Example to create an instance using the builder pattern
OrderSearchFilterExpressionBuilder Example to create an instance using the builder pattern
OrderSearchFilterExpression
 
OrderSearchFullTextExpression Example to create an instance using the builder pattern
OrderSearchFullTextExpressionBuilder Example to create an instance using the builder pattern
OrderSearchFullTextExpression
 
OrderSearchFullTextValue Example to create an instance using the builder pattern
OrderSearchFullTextValueBuilder Example to create an instance using the builder pattern
OrderSearchFullTextValue
 
OrderSearchLongRangeExpression Example to create an instance using the builder pattern
OrderSearchLongRangeExpressionBuilder Example to create an instance using the builder pattern
OrderSearchLongRangeExpression
 
OrderSearchLongRangeValue Example to create an instance using the builder pattern
OrderSearchLongRangeValueBuilder Example to create an instance using the builder pattern
OrderSearchLongRangeValue
 
OrderSearchMatchType
possible values of OrderSearchMatchType
OrderSearchNotExpression Example to create an instance using the builder pattern
OrderSearchNotExpressionBuilder Example to create an instance using the builder pattern
OrderSearchNotExpression
 
OrderSearchNumberRangeExpression Example to create an instance using the builder pattern
OrderSearchNumberRangeExpressionBuilder Example to create an instance using the builder pattern
OrderSearchNumberRangeExpression
 
OrderSearchNumberRangeValue Example to create an instance using the builder pattern
OrderSearchNumberRangeValueBuilder Example to create an instance using the builder pattern
OrderSearchNumberRangeValue
 
OrderSearchOrExpression Example to create an instance using the builder pattern
OrderSearchOrExpressionBuilder Example to create an instance using the builder pattern
OrderSearchOrExpression
 
OrderSearchPrefixExpression Example to create an instance using the builder pattern
OrderSearchPrefixExpressionBuilder Example to create an instance using the builder pattern
OrderSearchPrefixExpression
 
OrderSearchQuery Example to create an instance using the builder pattern
OrderSearchQueryBuilder Example to create an instance using the builder pattern
 
OrderSearchQueryExpression Example to create an instance using the builder pattern
OrderSearchQueryExpressionBuilder Example to create an instance using the builder pattern
OrderSearchQueryExpression
 
OrderSearchQueryExpressionValue Example to create an instance using the builder pattern
OrderSearchQueryExpressionValueBuilder Example to create an instance using the builder pattern
OrderSearchQueryExpressionValue
 
OrderSearchQuery
 
OrderSearchRequest Example to create an instance using the builder pattern
OrderSearchRequestBuilder Example to create an instance using the builder pattern
OrderSearchRequest
 
OrderSearchSorting Example to create an instance using the builder pattern
OrderSearchSortingBuilder Example to create an instance using the builder pattern
OrderSearchSorting
 
OrderSearchSortMode
possible values of OrderSearchSortMode
OrderSearchSortOrder
possible values of OrderSearchSortOrder
Specifies the status of the Order Search index.
possible values of OrderSearchStatus
OrderSearchStringValue Example to create an instance using the builder pattern
OrderSearchStringValueBuilder Example to create an instance using the builder pattern
OrderSearchStringValue
 
OrderSearchWildCardExpression Example to create an instance using the builder pattern
OrderSearchWildCardExpressionBuilder Example to create an instance using the builder pattern
OrderSearchWildCardExpression
 
OrderSetBillingAddressAction Example to create an instance using the builder pattern
OrderSetBillingAddressActionBuilder Example to create an instance using the builder pattern
OrderSetBillingAddressAction
 
OrderSetBillingAddressCustomFieldAction Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldAction
 
OrderSetBillingAddressCustomTypeAction Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeAction
 
OrderSetCustomerEmailAction Example to create an instance using the builder pattern
OrderSetCustomerEmailActionBuilder Example to create an instance using the builder pattern
OrderSetCustomerEmailAction
 
OrderSetCustomerIdAction Example to create an instance using the builder pattern
OrderSetCustomerIdActionBuilder Example to create an instance using the builder pattern
OrderSetCustomerIdAction
 
OrderSetCustomFieldAction Example to create an instance using the builder pattern
OrderSetCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetCustomFieldAction
 
OrderSetCustomLineItemCustomFieldAction Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldAction
 
OrderSetCustomLineItemCustomTypeAction Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeAction
 
OrderSetCustomLineItemShippingDetailsAction Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsAction
 
OrderSetCustomTypeAction Example to create an instance using the builder pattern
OrderSetCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetCustomTypeAction
 
OrderSetDeliveryAddressAction Example to create an instance using the builder pattern
OrderSetDeliveryAddressActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryAddressAction
 
OrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldAction
 
OrderSetDeliveryAddressCustomTypeAction Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeAction
 
OrderSetDeliveryCustomFieldAction Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldAction
 
OrderSetDeliveryCustomTypeAction Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeAction
 
OrderSetDeliveryItemsAction Example to create an instance using the builder pattern
OrderSetDeliveryItemsActionBuilder Example to create an instance using the builder pattern
OrderSetDeliveryItemsAction
 
OrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldAction
 
OrderSetItemShippingAddressCustomTypeAction Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeAction
 
OrderSetLineItemCustomFieldAction Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldAction
 
OrderSetLineItemCustomTypeAction Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeAction
 
OrderSetLineItemShippingDetailsAction Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsAction
 
OrderSetLocaleAction Example to create an instance using the builder pattern
OrderSetLocaleActionBuilder Example to create an instance using the builder pattern
OrderSetLocaleAction
 
OrderSetOrderNumberAction Example to create an instance using the builder pattern
OrderSetOrderNumberActionBuilder Example to create an instance using the builder pattern
OrderSetOrderNumberAction
 
OrderSetParcelCustomFieldAction Example to create an instance using the builder pattern
OrderSetParcelCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetParcelCustomFieldAction
 
OrderSetParcelCustomTypeAction Example to create an instance using the builder pattern
OrderSetParcelCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetParcelCustomTypeAction
 
OrderSetParcelItemsAction Example to create an instance using the builder pattern
OrderSetParcelItemsActionBuilder Example to create an instance using the builder pattern
OrderSetParcelItemsAction
 
OrderSetParcelMeasurementsAction Example to create an instance using the builder pattern
OrderSetParcelMeasurementsActionBuilder Example to create an instance using the builder pattern
OrderSetParcelMeasurementsAction
 
OrderSetParcelTrackingDataAction Example to create an instance using the builder pattern
OrderSetParcelTrackingDataActionBuilder Example to create an instance using the builder pattern
OrderSetParcelTrackingDataAction
 
OrderSetPurchaseOrderNumberAction Example to create an instance using the builder pattern
OrderSetPurchaseOrderNumberActionBuilder Example to create an instance using the builder pattern
OrderSetPurchaseOrderNumberAction
 
OrderSetReturnInfoAction Example to create an instance using the builder pattern
OrderSetReturnInfoActionBuilder Example to create an instance using the builder pattern
OrderSetReturnInfoAction
 
OrderSetReturnItemCustomFieldAction Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldAction
 
OrderSetReturnItemCustomTypeAction Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeAction
 
OrderSetReturnPaymentStateAction Example to create an instance using the builder pattern
OrderSetReturnPaymentStateActionBuilder Example to create an instance using the builder pattern
OrderSetReturnPaymentStateAction
 
OrderSetReturnShipmentStateAction Example to create an instance using the builder pattern
OrderSetReturnShipmentStateActionBuilder Example to create an instance using the builder pattern
OrderSetReturnShipmentStateAction
 
OrderSetShippingAddressAction Example to create an instance using the builder pattern
OrderSetShippingAddressActionBuilder Example to create an instance using the builder pattern
OrderSetShippingAddressAction
 
OrderSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldAction
 
OrderSetShippingAddressCustomTypeAction Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeAction
 
OrderSetStoreAction Example to create an instance using the builder pattern
OrderSetStoreActionBuilder Example to create an instance using the builder pattern
OrderSetStoreAction
 
Generated after a successful Change Shipment State update action.
OrderShipmentStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Shipment State update action.
Generated after a successful Change Shipment State update action.
OrderShipmentStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Shipment State update action.
 
 
Generated after a successful Set Shipping Address update action.
OrderShippingAddressSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Shipping Address update action.
Generated after a successful Set Shipping Address update action.
OrderShippingAddressSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Shipping Address update action.
 
 
Generated after a successful Set Shipping Method and Set Custom Shipping Method update actions.
OrderShippingInfoSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Shipping Method and Set Custom Shipping Method update actions.
Generated after a successful Set Shipping Method and Set Custom Shipping Method update actions.
OrderShippingInfoSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Shipping Method and Set Custom Shipping Method update actions.
 
 
Generated after a successful Set ShippingRateInput update action.
OrderShippingRateInputSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set ShippingRateInput update action.
Generated after a successful Set ShippingRateInput update action.
OrderShippingRateInputSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set ShippingRateInput update action.
 
 
OrderState
OrderState
Maps to Order.orderState.
possible values of OrderState
possible values of OrderState
possible values of OrderState
Generated after a successful Change Order State update action.
OrderStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Order State update action.
Generated after a successful Change Order State update action.
OrderStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Order State update action.
 
 
Generated after a successful Transition State update action.
OrderStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
OrderStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
Generated after a successful Set Store update action.
OrderStoreSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Store update action.
Generated after a successful Set Store update action.
OrderStoreSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Store update action.
 
 
OrderTransitionCustomLineItemStateAction Example to create an instance using the builder pattern
OrderTransitionCustomLineItemStateActionBuilder Example to create an instance using the builder pattern
OrderTransitionCustomLineItemStateAction
 
OrderTransitionLineItemStateAction Example to create an instance using the builder pattern
OrderTransitionLineItemStateActionBuilder Example to create an instance using the builder pattern
OrderTransitionLineItemStateAction
 
OrderTransitionStateAction Example to create an instance using the builder pattern
OrderTransitionStateActionBuilder Example to create an instance using the builder pattern
OrderTransitionStateAction
 
OrderUpdate Example to create an instance using the builder pattern
OrderUpdateAction Example to create a subtype instance using the builder pattern
OrderUpdateActionBuilder
OrderUpdateAction
 
OrderUpdateBuilder Example to create an instance using the builder pattern
OrderUpdate
OrderUpdateItemShippingAddressAction Example to create an instance using the builder pattern
OrderUpdateItemShippingAddressActionBuilder Example to create an instance using the builder pattern
OrderUpdateItemShippingAddressAction
 
 
OrderUpdateSyncInfoAction Example to create an instance using the builder pattern
OrderUpdateSyncInfoActionBuilder Example to create an instance using the builder pattern
OrderUpdateSyncInfoAction
 
Returned when some of the Line Items are out of stock at the time of placing an Order.
OutOfStockErrorBuilder Example to create an instance using the builder pattern
Returned when some of the Line Items are out of stock at the time of placing an Order.
 
Returned when the service is having trouble handling the load.
OverCapacityErrorBuilder Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
 
Returned when a given Price validity period conflicts with an existing one.
OverlappingStandalonePriceValidityErrorBuilder Example to create an instance using the builder pattern
Returned when a given Price validity period conflicts with an existing one.
 
Interface with common methods for query endpoints
Deprecated.
PagedQueryResponse Example to create an instance using the builder pattern
PagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResponse
 
PagingTrait
Parcel Example to create an instance using the builder pattern
Parcel Example to create an instance using the builder pattern
Parcel Example to create an instance using the builder pattern
Generated after a successful Add Parcel To Delivery update action.
ParcelAddedToDeliveryMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Parcel To Delivery update action.
Generated after a successful Add Parcel To Delivery update action.
ParcelAddedToDeliveryMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Parcel To Delivery update action.
 
 
ParcelBuilder Example to create an instance using the builder pattern
ParcelBuilder Example to create an instance using the builder pattern
ParcelBuilder Example to create an instance using the builder pattern
ParcelChangeValue Example to create an instance using the builder pattern
ParcelChangeValueBuilder Example to create an instance using the builder pattern
ParcelChangeValue
ParcelDraft Example to create an instance using the builder pattern
ParcelDraftBuilder Example to create an instance using the builder pattern
ParcelDraft
 
Parcel
Parcel
Parcel
ParcelItems Example to create an instance using the builder pattern
ParcelItemsBuilder Example to create an instance using the builder pattern
ParcelItems
Generated after a successful Set Parcel Items update action.
ParcelItemsUpdatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel Items update action.
Generated after a successful Set Parcel Items update action.
ParcelItemsUpdatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel Items update action.
 
 
ParcelMeasurementDraft Example to create an instance using the builder pattern
ParcelMeasurementDraftBuilder Example to create an instance using the builder pattern
ParcelMeasurementDraft
ParcelMeasurements Example to create an instance using the builder pattern
ParcelMeasurements Example to create an instance using the builder pattern
ParcelMeasurements Example to create an instance using the builder pattern
ParcelMeasurementsBuilder Example to create an instance using the builder pattern
ParcelMeasurementsBuilder Example to create an instance using the builder pattern
ParcelMeasurementsBuilder Example to create an instance using the builder pattern
ParcelMeasurements
ParcelMeasurements
ParcelMeasurements
 
Generated after a successful Set Parcel Measurements update action.
ParcelMeasurementsUpdatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel Measurements update action.
Generated after a successful Set Parcel Measurements update action.
ParcelMeasurementsUpdatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel Measurements update action.
 
 
 
 
Generated after a successful Remove Parcel From Delivery update action.
ParcelRemovedFromDeliveryMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Parcel From Delivery update action.
Generated after a successful Remove Parcel From Delivery update action.
ParcelRemovedFromDeliveryMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Parcel From Delivery update action.
 
 
ParcelTrackingData Example to create an instance using the builder pattern
ParcelTrackingDataBuilder Example to create an instance using the builder pattern
ParcelTrackingData
Generated after a successful Set Parcel TrackingData update action.
ParcelTrackingDataUpdatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel TrackingData update action.
Generated after a successful Set Parcel TrackingData update action.
ParcelTrackingDataUpdatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Parcel TrackingData update action.
 
 
PayloadNotIncluded Example to create an instance using the builder pattern
PayloadNotIncludedBuilder Example to create an instance using the builder pattern
PayloadNotIncluded
 
Payment Example to create an instance using the builder pattern
Adding a Payment interaction generates the PaymentInteractionAdded Message.
PaymentAddInterfaceInteractionActionBuilder Example to create an instance using the builder pattern
Adding a Payment interaction generates the PaymentInteractionAdded Message.
 
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
PaymentAddTransactionActionBuilder Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
 
PaymentBuilder Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
PaymentChangeAmountPlannedActionBuilder Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
 
PaymentChangeTransactionInteractionIdAction Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdActionBuilder Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdAction
 
Changing the TransactionState generates the PaymentTransactionStateChanged Message.
PaymentChangeTransactionStateActionBuilder Example to create an instance using the builder pattern
Changing the TransactionState generates the PaymentTransactionStateChanged Message.
 
PaymentChangeTransactionTimestampAction Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampActionBuilder Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampAction
 
Generated after a successful Create Payment request.
PaymentCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
Generated after a successful Create Payment request.
PaymentCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
 
 
PaymentDraft Example to create an instance using the builder pattern
PaymentDraftBuilder Example to create an instance using the builder pattern
PaymentDraft
 
Payment
PaymentInfo Example to create an instance using the builder pattern
PaymentInfo Example to create an instance using the builder pattern
PaymentInfoBuilder Example to create an instance using the builder pattern
PaymentInfoBuilder Example to create an instance using the builder pattern
PaymentInfo
PaymentInfo
 
Generated after a successful Add InterfaceInteraction update action.
PaymentInteractionAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add InterfaceInteraction update action.
Generated after a successful Add InterfaceInteraction update action.
PaymentInteractionAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add InterfaceInteraction update action.
 
 
References a payment by key.
PaymentKeyReferenceBuilder Example to create an instance using the builder pattern
References a payment by key.
PaymentLabel Example to create an instance using the builder pattern
PaymentLabelBuilder Example to create an instance using the builder pattern
PaymentLabel
PaymentMethodInfo Example to create an instance using the builder pattern
PaymentMethodInfoBuilder Example to create an instance using the builder pattern
PaymentMethodInfo
 
 
PagedQueryResult with results containing an array of Payment.
PaymentPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Payment.
 
 
Reference to a Payment.
PaymentReferenceBuilder Example to create an instance using the builder pattern
Reference to a Payment.
 
ResourceIdentifier of a Payment.
PaymentResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier of a Payment.
 
PaymentSetAnonymousIdAction Example to create an instance using the builder pattern
PaymentSetAnonymousIdActionBuilder Example to create an instance using the builder pattern
PaymentSetAnonymousIdAction
 
PaymentSetCustomerAction Example to create an instance using the builder pattern
PaymentSetCustomerActionBuilder Example to create an instance using the builder pattern
PaymentSetCustomerAction
 
PaymentSetCustomFieldAction Example to create an instance using the builder pattern
PaymentSetCustomFieldActionBuilder Example to create an instance using the builder pattern
PaymentSetCustomFieldAction
 
PaymentSetCustomTypeAction Example to create an instance using the builder pattern
PaymentSetCustomTypeActionBuilder Example to create an instance using the builder pattern
PaymentSetCustomTypeAction
 
PaymentSetInterfaceIdAction Example to create an instance using the builder pattern
PaymentSetInterfaceIdActionBuilder Example to create an instance using the builder pattern
PaymentSetInterfaceIdAction
 
PaymentSetKeyAction Example to create an instance using the builder pattern
PaymentSetKeyActionBuilder Example to create an instance using the builder pattern
PaymentSetKeyAction
 
PaymentSetMethodInfoInterfaceAction Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceActionBuilder Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceAction
 
PaymentSetMethodInfoMethodAction Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodActionBuilder Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodAction
 
PaymentSetMethodInfoNameAction Example to create an instance using the builder pattern
PaymentSetMethodInfoNameActionBuilder Example to create an instance using the builder pattern
PaymentSetMethodInfoNameAction
 
Produces the PaymentStatusInterfaceCodeSet Message.
PaymentSetStatusInterfaceCodeActionBuilder Example to create an instance using the builder pattern
Produces the PaymentStatusInterfaceCodeSet Message.
 
PaymentSetStatusInterfaceTextAction Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextActionBuilder Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextAction
 
PaymentSetTransactionCustomFieldAction Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldActionBuilder Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldAction
 
PaymentSetTransactionCustomTypeAction Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeActionBuilder Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeAction
 
PaymentState
PaymentState
Maps to Order.paymentState.
possible values of PaymentState
possible values of PaymentState
possible values of PaymentState
PaymentStatus Example to create an instance using the builder pattern
PaymentStatusBuilder Example to create an instance using the builder pattern
PaymentStatusDraft Example to create an instance using the builder pattern
PaymentStatusDraftBuilder Example to create an instance using the builder pattern
PaymentStatusDraft
 
PaymentStatus
Generated after a successful Set StatusInterfaceCode update action.
PaymentStatusInterfaceCodeSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set StatusInterfaceCode update action.
Generated after a successful Set StatusInterfaceCode update action.
PaymentStatusInterfaceCodeSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set StatusInterfaceCode update action.
 
 
 
Generated after a successful Transition State update action.
PaymentStatusStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
PaymentStatusStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
Generated after a successful Add Transaction update action.
PaymentTransactionAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Transaction update action.
Generated after a successful Add Transaction update action.
PaymentTransactionAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Transaction update action.
 
 
Generated after a successful Change Transaction State update action.
PaymentTransactionStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Transaction State update action.
Generated after a successful Change Transaction State update action.
PaymentTransactionStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Transaction State update action.
 
 
If the Payment has no current State, initial must be true for the new State.
PaymentTransitionStateActionBuilder Example to create an instance using the builder pattern
If the Payment has no current State, initial must be true for the new State.
 
PaymentUpdate Example to create an instance using the builder pattern
PaymentUpdateAction Example to create a subtype instance using the builder pattern
PaymentUpdateActionBuilder
PaymentUpdateAction
 
PaymentUpdateBuilder Example to create an instance using the builder pattern
PaymentUpdate
 
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
PendingOperationErrorBuilder Example to create an instance using the builder pattern
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
 
Permissions grant granular access to Business Units, Carts, Orders, Quotes, and QuoteRequests.
possible values of Permission
The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.
PlatformFormatBuilder Example to create an instance using the builder pattern
The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.
 
Updates that are triggered automatically as a result of a user-initiated change.
possible values of PlatformInitiatedChange
 
 
 
The representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode is Embedded.
Price Example to create an instance using the builder pattern
PriceBuilder Example to create an instance using the builder pattern
PriceBuilder Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
PriceChangedErrorBuilder Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
 
The draft representation for prices to be embedded into ProductVariantDrafts when the ProductPriceMode is Embedded.
PriceDraftBuilder Example to create an instance using the builder pattern
The draft representation for prices to be embedded into ProductVariantDrafts when the ProductPriceMode is Embedded.
The representation of a Price Draft for the import purpose.
PriceDraftImportBuilder Example to create an instance using the builder pattern
The representation of a Price Draft for the import purpose.
 
PriceFunction Example to create an instance using the builder pattern
PriceFunctionBuilder Example to create an instance using the builder pattern
PriceFunction
 
The representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode is Embedded.
Price
The data representation for a price to be imported that is persisted as a Price in the Project.
PriceImportBuilder Example to create an instance using the builder pattern
The data representation for a price to be imported that is persisted as a Price in the Project.
The request body to import Embedded Prices.
PriceImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Embedded Prices.
References a price by key.
PriceKeyReferenceBuilder Example to create an instance using the builder pattern
References a price by key.
 
PriceselectingTrait
A Price tier is selected instead of the default Price when a certain quantity of the ProductVariant is added to a Cart and ordered.
A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
PriceTierBuilder Example to create an instance using the builder pattern
PriceTierBuilder Example to create an instance using the builder pattern
Specifies a Price tier that applies when the minimum quantity for the LineItem of a ProductVariant with the related Price is reached in a Cart.
PriceTierDraftBuilder Example to create an instance using the builder pattern
Specifies a Price tier that applies when the minimum quantity for the LineItem of a ProductVariant with the related Price is reached in a Cart.
 
A Price tier is selected instead of the default Price when a certain quantity of the ProductVariant is added to a Cart and ordered.
A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
 
Every Import Operation is assigned with one of the following states.
possible values of ProcessingState
An abstract sellable good with a set of Attributes defined by a Product Type.
Either variantId or sku is required.
ProductAddAssetActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Generated after a successful Add To Category update action.
ProductAddedToCategoryMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add To Category update action.
Generated after a successful Add To Category update action.
ProductAddedToCategoryMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add To Category update action.
 
 
Either variantId or sku is required.
ProductAddExternalImageActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Adds the given Price to the prices array of the ProductVariant.
ProductAddPriceActionBuilder Example to create an instance using the builder pattern
Adds the given Price to the prices array of the ProductVariant.
 
Produces the ProductAddedToCategory Message.
ProductAddToCategoryActionBuilder Example to create an instance using the builder pattern
Produces the ProductAddedToCategory Message.
 
ProductAddVariantAction Example to create an instance using the builder pattern
ProductAddVariantActionBuilder Example to create an instance using the builder pattern
ProductAddVariantAction
 
Returned when a Product is not assigned to the Product Selection.
ProductAssignmentMissingErrorBuilder Example to create an instance using the builder pattern
Returned when a Product is not assigned to the Product Selection.
 
ProductBuilder Example to create an instance using the builder pattern
Contains the current and staged ProductData.
ProductCatalogDataBuilder Example to create an instance using the builder pattern
Contains the current and staged ProductData.
 
 
Either variantId or sku is required.
ProductChangeAssetNameActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductChangeAssetOrderActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Assigns the specified Product Variant to the masterVariant and removes the same from variants at the same time.
ProductChangeMasterVariantActionBuilder Example to create an instance using the builder pattern
Assigns the specified Product Variant to the masterVariant and removes the same from variants at the same time.
 
ProductChangeNameAction Example to create an instance using the builder pattern
ProductChangeNameActionBuilder Example to create an instance using the builder pattern
ProductChangeNameAction
 
ProductChangePriceAction Example to create an instance using the builder pattern
ProductChangePriceActionBuilder Example to create an instance using the builder pattern
ProductChangePriceAction
 
Produces the ProductSlugChanged Message.
ProductChangeSlugActionBuilder Example to create an instance using the builder pattern
Produces the ProductSlugChanged Message.
 
Generated after a successful Create Product request.
ProductCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Product request.
Generated after a successful Create Product request.
ProductCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Product request.
 
 
Contains all the data of a Product and its Product Variants.
ProductDataBuilder Example to create an instance using the builder pattern
Contains all the data of a Product and its Product Variants.
Interface to describe commonalities between differen product representations
 
Generated after a successful Delete Product request.
ProductDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Product request.
Generated after a successful Delete Product request.
ProductDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Product request.
 
 
ProductDiscount Example to create an instance using the builder pattern
ProductDiscountBuilder Example to create an instance using the builder pattern
ProductDiscountChangeIsActiveAction Example to create an instance using the builder pattern
ProductDiscountChangeIsActiveActionBuilder Example to create an instance using the builder pattern
ProductDiscountChangeIsActiveAction
 
ProductDiscountChangeNameAction Example to create an instance using the builder pattern
ProductDiscountChangeNameActionBuilder Example to create an instance using the builder pattern
ProductDiscountChangeNameAction
 
ProductDiscountChangePredicateAction Example to create an instance using the builder pattern
ProductDiscountChangePredicateActionBuilder Example to create an instance using the builder pattern
ProductDiscountChangePredicateAction
 
ProductDiscountChangeSortOrderAction Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderActionBuilder Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderAction
 
ProductDiscountChangeValueAction Example to create an instance using the builder pattern
ProductDiscountChangeValueActionBuilder Example to create an instance using the builder pattern
ProductDiscountChangeValueAction
 
ProductDiscountDraft Example to create an instance using the builder pattern
ProductDiscountDraftBuilder Example to create an instance using the builder pattern
ProductDiscountDraft
 
ProductDiscount
References a product discount by key.
ProductDiscountKeyReferenceBuilder Example to create an instance using the builder pattern
References a product discount by key.
ProductDiscountMatchQuery Example to create an instance using the builder pattern
ProductDiscountMatchQueryBuilder Example to create an instance using the builder pattern
ProductDiscountMatchQuery
 
 
PagedQueryResult with results containing an array of ProductDiscount.
ProductDiscountPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductDiscount.
 
 
Reference to a ProductDiscount.
ProductDiscountReferenceBuilder Example to create an instance using the builder pattern
Reference to a ProductDiscount.
 
ResourceIdentifier to a ProductDiscount.
ProductDiscountResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a ProductDiscount.
 
ProductDiscountSetDescriptionAction Example to create an instance using the builder pattern
ProductDiscountSetDescriptionActionBuilder Example to create an instance using the builder pattern
ProductDiscountSetDescriptionAction
 
ProductDiscountSetKeyAction Example to create an instance using the builder pattern
ProductDiscountSetKeyActionBuilder Example to create an instance using the builder pattern
ProductDiscountSetKeyAction
 
ProductDiscountSetValidFromAction Example to create an instance using the builder pattern
ProductDiscountSetValidFromActionBuilder Example to create an instance using the builder pattern
ProductDiscountSetValidFromAction
 
ProductDiscountSetValidFromAndUntilAction Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilActionBuilder Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilAction
 
ProductDiscountSetValidUntilAction Example to create an instance using the builder pattern
ProductDiscountSetValidUntilActionBuilder Example to create an instance using the builder pattern
ProductDiscountSetValidUntilAction
 
ProductDiscountUpdate Example to create an instance using the builder pattern
ProductDiscountUpdateAction Example to create a subtype instance using the builder pattern
ProductDiscountUpdateActionBuilder
ProductDiscountUpdateAction
 
ProductDiscountUpdateBuilder Example to create an instance using the builder pattern
ProductDiscountUpdate
 
ProductDiscountValue Example to create a subtype instance using the builder pattern
Discounts the Product's Price by a fixed amount, defined by the money field.
ProductDiscountValueAbsoluteBuilder Example to create an instance using the builder pattern
Discounts the Product Price by a fixed amount, defined by the money field.
ProductDiscountValueAbsoluteDraftBuilder Example to create an instance using the builder pattern
Discounts the Product Price by a fixed amount, defined by the money field.
 
Discounts the Product's Price by a fixed amount, defined by the money field.
 
ProductDiscountValueBuilder
ProductDiscountValueDraft Example to create a subtype instance using the builder pattern
ProductDiscountValueDraftBuilder
ProductDiscountValueDraft
 
Discounts the Product Price by allowing the client to explicitly set a discounted value.
ProductDiscountValueExternalBuilder Example to create an instance using the builder pattern
Discounts the Product Price by allowing the client to explicitly set a discounted value.
ProductDiscountValueExternalDraftBuilder Example to create an instance using the builder pattern
Discounts the Product Price by allowing the client to explicitly set a discounted value.
 
Discounts the Product Price by allowing the client to explicitly set a discounted value.
 
ProductDiscountValue
 
Discounts the product price by a percentage, defined by the permyriad field.
ProductDiscountValueRelativeBuilder Example to create an instance using the builder pattern
Discounts the Product Price by a percentage, defined by the permyriad field.
ProductDiscountValueRelativeDraftBuilder Example to create an instance using the builder pattern
Discounts the Product Price by a percentage, defined by the permyriad field.
 
Discounts the product price by a percentage, defined by the permyriad field.
 
ProductDraft Example to create an instance using the builder pattern
ProductDraftBuilder Example to create an instance using the builder pattern
ProductDraft
The representation of a Product Draft for the import purpose.
ProductDraftImportBuilder Example to create an instance using the builder pattern
The representation of a Product Draft for the import purpose.
The request body to import ProductDrafts.
ProductDraftImportRequestBuilder Example to create an instance using the builder pattern
The request body to import ProductDrafts.
 
Generated after a successful Add External Image update action or after the successful upload of an image.
ProductImageAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add External Image update action or after the successful upload of an image.
Generated after a successful Add External Image update action or after the successful upload of an image.
ProductImageAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add External Image update action or after the successful upload of an image.
 
 
An abstract sellable good with a set of Attributes defined by a Product Type.
The data representation for a Product to be imported that is persisted as a Product in the Project.
ProductImportBuilder Example to create an instance using the builder pattern
The data representation for a Product to be imported that is persisted as a Product in the Project.
The request body to import Products.
ProductImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Products.
References a product by key.
ProductKeyReferenceBuilder Example to create an instance using the builder pattern
References a product by key.
ProductLabel Example to create an instance using the builder pattern
ProductLabelBuilder Example to create an instance using the builder pattern
ProductLabel
ProductLegacySetSkuAction Example to create an instance using the builder pattern
ProductLegacySetSkuActionBuilder Example to create an instance using the builder pattern
ProductLegacySetSkuAction
 
 
Either variantId or sku is required.
ProductMoveImageToPositionActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
PagedQueryResult with results containing an array of Product.
ProductPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Product.
 
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
ProductPresentWithDifferentVariantSelectionErrorBuilder Example to create an instance using the builder pattern
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
 
Generated after a successful Add Embedded Price update action.
ProductPriceAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Embedded Price update action.
Generated after a successful Add Embedded Price update action.
ProductPriceAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Embedded Price update action.
 
 
Generated after a successful Change Embedded Price update action.
ProductPriceChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Embedded Price update action.
Generated after a successful Change Embedded Price update action.
ProductPriceChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Embedded Price update action.
 
 
Generated after a Price is updated due to a Product Discount.
ProductPriceDiscountsSetMessageBuilder Example to create an instance using the builder pattern
Generated after a Price is updated due to a Product Discount.
Generated after a Price is updated due to a Product Discount.
ProductPriceDiscountsSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a Price is updated due to a Product Discount.
 
 
Details about a Embedded Price that was updated due to a Discount.
ProductPriceDiscountsSetUpdatedPriceBuilder Example to create an instance using the builder pattern
Details about a Embedded Price that was updated due to a Discount.
 
Generated after a successful Set Discounted Embedded Price update action.
ProductPriceExternalDiscountSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Discounted Embedded Price update action.
Generated after a successful Set Discounted Embedded Price update action.
ProductPriceExternalDiscountSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Discounted Embedded Price update action.
 
 
Generated after a successful Set Price Key update action.
ProductPriceKeySetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Price Key update action.
Generated after a successful Set Price Key update action.
ProductPriceKeySetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Price Key update action.
 
 
This mode determines the type of Prices used for Product Price Selection and for LineItem Price selection.
ProductPriceModeEnum
possible values of ProductPriceModeEnum
possible values of ProductPriceModeEnum
Generated after a successful Set PriceMode update action.
ProductPriceModeSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set PriceMode update action.
Generated after a successful Set PriceMode update action.
ProductPriceModeSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set PriceMode update action.
 
 
Generated after a successful Remove Embedded Price update action.
ProductPriceRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Embedded Price update action.
Generated after a successful Remove Embedded Price update action.
ProductPriceRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Embedded Price update action.
 
 
Generated after a successful Set Embedded Prices update action.
ProductPricesSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Embedded Prices update action.
Generated after a successful Set Embedded Prices update action.
ProductPricesSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Embedded Prices update action.
 
 
ProductProjection Example to create an instance using the builder pattern
ProductProjectionBuilder Example to create an instance using the builder pattern
ProductProjection
 
ProductProjectionPagedQueryResponse Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponseBuilder Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponse
 
ProductProjectionPagedSearchResponse Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponseBuilder Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponse
 
 
 
Publishes product data from the Product's staged projection to its current projection.
ProductPublishActionBuilder Example to create an instance using the builder pattern
Publishes product data from the Product's staged projection to its current projection.
 
Generated after a successful Publish update action.
ProductPublishedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Publish update action.
Generated after a successful Publish update action.
ProductPublishedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Publish update action.
 
 
The scope controls which part of the product information is published.
possible values of ProductPublishScope
 
Reference to a Product.
ProductReference Example to create an instance using the builder pattern
ProductReferenceBuilder Example to create an instance using the builder pattern
ProductReferenceBuilder Example to create an instance using the builder pattern
Reference to a Product.
ProductReference
 
Either variantId or sku is required.
ProductRemoveAssetActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Generated after a successful Remove From Category update action.
ProductRemovedFromCategoryMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove From Category update action.
Generated after a successful Remove From Category update action.
ProductRemovedFromCategoryMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove From Category update action.
 
 
Produces the ProductRemovedFromCategory Message.
ProductRemoveFromCategoryActionBuilder Example to create an instance using the builder pattern
Produces the ProductRemovedFromCategory Message.
 
Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted).
ProductRemoveImageActionBuilder Example to create an instance using the builder pattern
Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted).
 
ProductRemovePriceAction Example to create an instance using the builder pattern
ProductRemovePriceActionBuilder Example to create an instance using the builder pattern
ProductRemovePriceAction
 
Either id or sku is required.
ProductRemoveVariantActionBuilder Example to create an instance using the builder pattern
Either id or sku is required.
 
ResourceIdentifier to a Product.
ProductResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Product.
 
Generated after a successful Revert Staged Changes update action.
ProductRevertedStagedChangesMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Revert Staged Changes update action.
Generated after a successful Revert Staged Changes update action.
ProductRevertedStagedChangesMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Revert Staged Changes update action.
 
 
Reverts the staged version of a Product to the current version.
ProductRevertStagedChangesActionBuilder Example to create an instance using the builder pattern
Reverts the staged version of a Product to the current version.
 
Reverts the staged version of a ProductVariant to the current version.
ProductRevertStagedVariantChangesActionBuilder Example to create an instance using the builder pattern
Reverts the staged version of a ProductVariant to the current version.
 
ProductSelection Example to create an instance using the builder pattern
Adds a Product to the Product Selection.
ProductSelectionAddProductActionBuilder Example to create an instance using the builder pattern
Adds a Product to the Product Selection.
 
Given the mode of Product Selection, this assignment refers to, it may contain:
ProductSelectionAssignmentBuilder Example to create an instance using the builder pattern
Given the mode of Product Selection, this assignment refers to, it may contain:
 
ProductSelectionBuilder Example to create an instance using the builder pattern
ProductSelectionChangeNameAction Example to create an instance using the builder pattern
ProductSelectionChangeNameActionBuilder Example to create an instance using the builder pattern
ProductSelectionChangeNameAction
 
Generated after a successful Create Product Selection request.
ProductSelectionCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Product Selection request.
Generated after a successful Create Product Selection request.
ProductSelectionCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Product Selection request.
 
 
Generated after a successful Delete Product Selection request.
ProductSelectionDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Product Selection request.
Generated after a successful Delete Product Selection request.
ProductSelectionDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Product Selection request.
 
 
ProductSelectionDraft Example to create an instance using the builder pattern
ProductSelectionDraftBuilder Example to create an instance using the builder pattern
ProductSelectionDraft
 
Excludes a Product from a Product Selection with IndividualExclusion ProductSelectionMode.
ProductSelectionExcludeProductActionBuilder Example to create an instance using the builder pattern
Excludes a Product from a Product Selection with IndividualExclusion ProductSelectionMode.
 
ProductSelection
 
Product Selections can have the following modes:
possible values of ProductSelectionMode
PagedQueryResult containing an array of ProductSelection.
ProductSelectionPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult containing an array of ProductSelection.
 
Generated after a successful Add Product update action.
ProductSelectionProductAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Product update action.
Generated after a successful Add Product update action.
ProductSelectionProductAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Product update action.
 
 
Generated after a successful Exclude Product update action.
ProductSelectionProductExcludedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Exclude Product update action.
Generated after a successful Exclude Product update action.
ProductSelectionProductExcludedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Exclude Product update action.
 
 
PagedQueryResult containing an array of AssignedProductReference.
ProductSelectionProductPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductReference.
 
Generated after a successful Remove Product update action.
ProductSelectionProductRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Product update action.
Generated after a successful Remove Product update action.
ProductSelectionProductRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Product update action.
 
 
 
Reference to a ProductSelection.
ProductSelectionReferenceBuilder Example to create an instance using the builder pattern
Reference to a ProductSelection.
 
ProductSelectionRemoveProductAction Example to create an instance using the builder pattern
ProductSelectionRemoveProductActionBuilder Example to create an instance using the builder pattern
ProductSelectionRemoveProductAction
 
ResourceIdentifier to a ProductSelection.
ProductSelectionResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a ProductSelection.
 
ProductSelectionSetCustomFieldAction Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldActionBuilder Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldAction
 
ProductSelectionSetCustomTypeAction Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeActionBuilder Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeAction
 
ProductSelectionSetKeyAction Example to create an instance using the builder pattern
ProductSelectionSetKeyActionBuilder Example to create an instance using the builder pattern
ProductSelectionSetKeyAction
 
ProductSelectionSetting Example to create an instance using the builder pattern
ProductSelectionSetting Example to create an instance using the builder pattern
ProductSelectionSettingBuilder Example to create an instance using the builder pattern
ProductSelectionSettingBuilder Example to create an instance using the builder pattern
ProductSelectionSettingDraft Example to create an instance using the builder pattern
ProductSelectionSettingDraftBuilder Example to create an instance using the builder pattern
ProductSelectionSettingDraft
 
ProductSelectionSetting
ProductSelectionSetting
 
Updates the Product Variant Exclusion of an existing Product Selection Assignment.
ProductSelectionSetVariantExclusionActionBuilder Example to create an instance using the builder pattern
Updates the Product Variant Exclusion of an existing Product Selection Assignment.
 
Updates the Product Variant Selection of an existing Product Selection Assignment.
ProductSelectionSetVariantSelectionActionBuilder Example to create an instance using the builder pattern
Updates the Product Variant Selection of an existing Product Selection Assignment.
 
Deprecated.
Deprecated.
The following types of Product Selections are supported:
possible values of ProductSelectionTypeEnum
Deprecated.
Deprecated.
ProductSelectionUpdate Example to create an instance using the builder pattern
ProductSelectionUpdateAction Example to create a subtype instance using the builder pattern
ProductSelectionUpdateActionBuilder
ProductSelectionUpdateAction
 
ProductSelectionUpdateBuilder Example to create an instance using the builder pattern
ProductSelectionUpdate
 
Generated after a successful Set Variant Exclusion update action.
ProductSelectionVariantExclusionChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Variant Exclusion update action.
Generated after a successful Set Variant Exclusion update action.
ProductSelectionVariantExclusionChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Variant Exclusion update action.
 
 
Generated after a successful Set Variant Selection update action.
ProductSelectionVariantSelectionChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Variant Selection update action.
Generated after a successful Set Variant Selection update action.
ProductSelectionVariantSelectionChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Variant Selection update action.
 
 
Either variantId or sku is required.
ProductSetAssetCustomFieldActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAssetCustomTypeActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAssetDescriptionActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAssetKeyActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAssetSourcesActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAssetTagsActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Either variantId or sku is required.
ProductSetAttributeActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
Adds, removes, or changes a Product Attribute in all Product Variants at the same time.
ProductSetAttributeInAllVariantsActionBuilder Example to create an instance using the builder pattern
Adds, removes, or changes a Product Attribute in all Product Variants at the same time.
 
ProductSetCategoryOrderHintAction Example to create an instance using the builder pattern
ProductSetCategoryOrderHintActionBuilder Example to create an instance using the builder pattern
ProductSetCategoryOrderHintAction
 
ProductSetDescriptionAction Example to create an instance using the builder pattern
ProductSetDescriptionActionBuilder Example to create an instance using the builder pattern
ProductSetDescriptionAction
 
Produces the ProductPriceExternalDiscountSet Message.
ProductSetDiscountedPriceActionBuilder Example to create an instance using the builder pattern
Produces the ProductPriceExternalDiscountSet Message.
 
Either variantId or sku is required.
ProductSetImageLabelActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
ProductSetKeyAction Example to create an instance using the builder pattern
ProductSetKeyActionBuilder Example to create an instance using the builder pattern
ProductSetKeyAction
 
ProductSetMetaDescriptionAction Example to create an instance using the builder pattern
ProductSetMetaDescriptionActionBuilder Example to create an instance using the builder pattern
ProductSetMetaDescriptionAction
 
ProductSetMetaKeywordsAction Example to create an instance using the builder pattern
ProductSetMetaKeywordsActionBuilder Example to create an instance using the builder pattern
ProductSetMetaKeywordsAction
 
ProductSetMetaTitleAction Example to create an instance using the builder pattern
ProductSetMetaTitleActionBuilder Example to create an instance using the builder pattern
ProductSetMetaTitleAction
 
Sets the key of an Embedded Price.
ProductSetPriceKeyActionBuilder Example to create an instance using the builder pattern
Sets the key of an Embedded Price.
 
Controls whether the Prices of a Product Variant are embedded into the Product or standalone.
ProductSetPriceModeActionBuilder Example to create an instance using the builder pattern
Controls whether the Prices of a Product Variant are embedded into the Product or standalone.
 
Either variantId or sku is required.
ProductSetPricesActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
ProductSetProductPriceCustomFieldAction Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldActionBuilder Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldAction
 
ProductSetProductPriceCustomTypeAction Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeActionBuilder Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeAction
 
Either variantId or sku is required.
ProductSetProductVariantKeyActionBuilder Example to create an instance using the builder pattern
Either variantId or sku is required.
 
ProductSetSearchKeywordsAction Example to create an instance using the builder pattern
ProductSetSearchKeywordsActionBuilder Example to create an instance using the builder pattern
ProductSetSearchKeywordsAction
 
A set of ProductData for comparison.
ProductSetSelectorBuilder Example to create an instance using the builder pattern
A set of ProductData for comparison.
SKU cannot be changed or removed if it is associated with an InventoryEntry.
ProductSetSkuActionBuilder Example to create an instance using the builder pattern
SKU cannot be changed or removed if it is associated with an InventoryEntry.
 
Cannot be staged.
ProductSetTaxCategoryActionBuilder Example to create an instance using the builder pattern
Cannot be staged.
 
PagedQueryResult containing an array of ProductSelectionAssignment.
ProductsInStorePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult containing an array of ProductSelectionAssignment.
 
Generated after a successful Change Slug update action.
ProductSlugChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
Generated after a successful Change Slug update action.
ProductSlugChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
 
 
Generated after a successful Transition State update action.
ProductStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
ProductStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
If the existing State has set transitions, there must be a direct transition to the new State.
ProductTransitionStateActionBuilder Example to create an instance using the builder pattern
If the existing State has set transitions, there must be a direct transition to the new State.
 
ProductType Example to create an instance using the builder pattern
ProductTypeAddAttributeDefinitionAction Example to create an instance using the builder pattern
ProductTypeAddAttributeDefinitionActionBuilder Example to create an instance using the builder pattern
ProductTypeAddAttributeDefinitionAction
 
Adds a localizable enum to the values of AttributeLocalizedEnumType.
ProductTypeAddLocalizedEnumValueActionBuilder Example to create an instance using the builder pattern
Adds a localizable enum to the values of AttributeLocalizedEnumType.
 
Adds an enum to the values of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
ProductTypeAddPlainEnumValueActionBuilder Example to create an instance using the builder pattern
Adds an enum to the values of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
 
ProductTypeBuilder Example to create an instance using the builder pattern
Updates the attributeConstraint of an AttributeDefinition.
ProductTypeChangeAttributeConstraintActionBuilder Example to create an instance using the builder pattern
Updates the attributeConstraint of an AttributeDefinition.
 
Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType.
ProductTypeChangeAttributeNameActionBuilder Example to create an instance using the builder pattern
Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType.
 
ProductTypeChangeAttributeOrderByNameAction Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameActionBuilder Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameAction
 
ProductTypeChangeDescriptionAction Example to create an instance using the builder pattern
ProductTypeChangeDescriptionActionBuilder Example to create an instance using the builder pattern
ProductTypeChangeDescriptionAction
 
Updates the key of a single enum value in an AttributeEnumType AttributeDefinition, AttributeLocalizedEnumType AttributeDefinition, AttributeSetType of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.
ProductTypeChangeEnumKeyActionBuilder Example to create an instance using the builder pattern
Updates the key of a single enum value in an AttributeEnumType AttributeDefinition, AttributeLocalizedEnumType AttributeDefinition, AttributeSetType of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.
 
Updates the inputHint of an AttributeDefinition.
ProductTypeChangeInputHintActionBuilder Example to create an instance using the builder pattern
Updates the inputHint of an AttributeDefinition.
 
Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint.
ProductTypeChangeIsSearchableActionBuilder Example to create an instance using the builder pattern
Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint.
 
ProductTypeChangeLabelAction Example to create an instance using the builder pattern
ProductTypeChangeLabelActionBuilder Example to create an instance using the builder pattern
ProductTypeChangeLabelAction
 
Updates the label of a single enum value in an AttributeLocalizedEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.
ProductTypeChangeLocalizedEnumValueLabelActionBuilder Example to create an instance using the builder pattern
Updates the label of a single enum value in an AttributeLocalizedEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.
 
Updates the order of localized enum values in an AttributeLocalizedEnumType AttributeDefinition.
ProductTypeChangeLocalizedEnumValueOrderActionBuilder Example to create an instance using the builder pattern
Updates the order of localized enum values in an AttributeLocalizedEnumType AttributeDefinition.
 
ProductTypeChangeNameAction Example to create an instance using the builder pattern
ProductTypeChangeNameActionBuilder Example to create an instance using the builder pattern
ProductTypeChangeNameAction
 
Updates the label of a single enum value in an AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
ProductTypeChangePlainEnumValueLabelActionBuilder Example to create an instance using the builder pattern
Updates the label of a single enum value in an AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
 
Updates the order of enum values in an AttributeEnumType AttributeDefinition.
ProductTypeChangePlainEnumValueOrderActionBuilder Example to create an instance using the builder pattern
Updates the order of enum values in an AttributeEnumType AttributeDefinition.
 
ProductTypeDraft Example to create an instance using the builder pattern
ProductTypeDraftBuilder Example to create an instance using the builder pattern
ProductTypeDraft
 
ProductType
The data representation for a ProductType to be imported that is persisted as a ProductType in the Project.
ProductTypeImportBuilder Example to create an instance using the builder pattern
The data representation for a ProductType to be imported that is persisted as a ProductType in the Project.
The request body to import ProductTypes.
ProductTypeImportRequestBuilder Example to create an instance using the builder pattern
The request body to import ProductTypes.
References a product type by key.
ProductTypeKeyReferenceBuilder Example to create an instance using the builder pattern
References a product type by key.
 
PagedQueryResult with results containing an array of ProductType.
ProductTypePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductType.
 
 
Reference to a ProductType.
ProductTypeReference Example to create an instance using the builder pattern
ProductTypeReferenceBuilder Example to create an instance using the builder pattern
ProductTypeReferenceBuilder Example to create an instance using the builder pattern
Reference to a ProductType.
ProductTypeReference
 
Removes an AttributeDefinition and also deletes all corresponding Attributes on all Products with this ProductType.
ProductTypeRemoveAttributeDefinitionActionBuilder Example to create an instance using the builder pattern
Removes an AttributeDefinition and also deletes all corresponding Attributes on all Products with this ProductType.
 
Removes enum values from an AttributeDefinition of AttributeEnumType, AttributeLocalizedEnumType, AttributeSetType of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.
ProductTypeRemoveEnumValuesActionBuilder Example to create an instance using the builder pattern
Removes enum values from an AttributeDefinition of AttributeEnumType, AttributeLocalizedEnumType, AttributeSetType of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.
 
ResourceIdentifier to a ProductType.
ProductTypeResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a ProductType.
 
ProductTypeSetInputTipAction Example to create an instance using the builder pattern
ProductTypeSetInputTipActionBuilder Example to create an instance using the builder pattern
ProductTypeSetInputTipAction
 
ProductTypeSetKeyAction Example to create an instance using the builder pattern
ProductTypeSetKeyActionBuilder Example to create an instance using the builder pattern
ProductTypeSetKeyAction
 
ProductTypeUpdate Example to create an instance using the builder pattern
ProductTypeUpdateAction Example to create a subtype instance using the builder pattern
ProductTypeUpdateActionBuilder
ProductTypeUpdateAction
 
ProductTypeUpdateBuilder Example to create an instance using the builder pattern
ProductTypeUpdate
 
Removes the current projection of the Product.
ProductUnpublishActionBuilder Example to create an instance using the builder pattern
Removes the current projection of the Product.
 
Generated after a successful Unpublish Product update action.
ProductUnpublishedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Unpublish Product update action.
Generated after a successful Unpublish Product update action.
ProductUnpublishedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Unpublish Product update action.
 
 
ProductUpdate Example to create an instance using the builder pattern
ProductUpdateAction Example to create a subtype instance using the builder pattern
ProductUpdateActionBuilder
ProductUpdateAction
 
ProductUpdateBuilder Example to create an instance using the builder pattern
ProductUpdate
 
A concrete sellable good for which inventory can be tracked.
The product variant that contains the image.
Generated after a successful Add Product Variant update action.
ProductVariantAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Product Variant update action.
Generated after a successful Add Product Variant update action.
ProductVariantAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Product Variant update action.
 
 
The InventoryEntry information of the Product Variant.
ProductVariantAvailability Example to create an instance using the builder pattern
ProductVariantAvailabilityBuilder Example to create an instance using the builder pattern
ProductVariantAvailabilityBuilder Example to create an instance using the builder pattern
The InventoryEntry information of the Product Variant.
ProductVariantAvailability
 
ProductVariantBuilder Example to create an instance using the builder pattern
ProductVariantBuilder Example to create an instance using the builder pattern
ProductVariantChannelAvailability Example to create an instance using the builder pattern
ProductVariantChannelAvailability Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityBuilder Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityBuilder Example to create an instance using the builder pattern
ProductVariantChannelAvailability
ProductVariantChannelAvailability
JSON object where the key is a supply Channel id and the value is the ProductVariantChannelAvailability of the InventoryEntry.
ProductVariantChannelAvailabilityMap Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityMapBuilder Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityMapBuilder Example to create an instance using the builder pattern
JSON object where the key is a supply Channel id and the value is the ProductVariantChannelAvailability of the InventoryEntry.
ProductVariantChannelAvailabilityMap
 
 
Generated after a successful Remove Product Variant update action.
ProductVariantDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Product Variant update action.
Generated after a successful Remove Product Variant update action.
ProductVariantDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Product Variant update action.
 
 
Creates a Product Variant when included in the masterVariant and variants fields of the ProductDraft.
ProductVariantDraftBuilder Example to create an instance using the builder pattern
Creates a Product Variant when included in the masterVariant and variants fields of the ProductDraft.
The representation of a Product Variant Draft for the import purpose.
ProductVariantDraftImportBuilder Example to create an instance using the builder pattern
The representation of a Product Variant Draft for the import purpose.
 
Only Product Variants with the explicitly listed SKUs are part of a Product Selection with IndividualExclusion ProductSelectionMode.
ProductVariantExclusionBuilder Example to create an instance using the builder pattern
Only Product Variants with the explicitly listed SKUs are part of a Product Selection with IndividualExclusion ProductSelectionMode.
 
A concrete sellable good for which inventory can be tracked.
The product variant that contains the image.
The data representation for a ProductVariant to be imported that is persisted as a ProductVariant in the Project.
ProductVariantImportBuilder Example to create an instance using the builder pattern
ProductVariantImportDraft Example to create an instance using the builder pattern
ProductVariantImportDraftBuilder Example to create an instance using the builder pattern
ProductVariantImportDraft
 
The data representation for a ProductVariant to be imported that is persisted as a ProductVariant in the Project.
The request body to import ProductVariants.
ProductVariantImportRequestBuilder Example to create an instance using the builder pattern
The request body to import ProductVariants.
References a product variant by key.
ProductVariantKeyReferenceBuilder Example to create an instance using the builder pattern
References a product variant by key.
Representation for an update of a ProductVariant.
ProductVariantPatchBuilder Example to create an instance using the builder pattern
Representation for an update of a ProductVariant.
The request body to import ProductVariantPatches.
ProductVariantPatchRequestBuilder Example to create an instance using the builder pattern
The request body to import ProductVariantPatches.
 
Polymorphic base type for Product Variant Selections.
ProductVariantSelectionBuilder
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Polymorphic base type for Product Variant Selections.
All Product Variants except the explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeAllExceptBuilder Example to create an instance using the builder pattern
All Product Variants except the explicitly stated SKUs are part of the Product Selection.
 
Only Product Variants with explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeOnlyBuilder Example to create an instance using the builder pattern
Only Product Variants with explicitly stated SKUs are part of the Product Selection.
 
Deprecated.
Deprecated.
Deprecated.
Deprecated.
 
ProductVariantSelectionTypeEnum
possible values of ProductVariantSelectionTypeEnum
Project Example to create an instance using the builder pattern
Project scoped API root
 
 
 
ProjectBuilder Example to create an instance using the builder pattern
ProjectCategoryRecommendation Example to create an instance using the builder pattern
ProjectCategoryRecommendationBuilder Example to create an instance using the builder pattern
ProjectCategoryRecommendation
ProjectCategoryRecommendationMeta Example to create an instance using the builder pattern
ProjectCategoryRecommendationMetaBuilder Example to create an instance using the builder pattern
ProjectCategoryRecommendationMeta
ProjectCategoryRecommendationPagedQueryResponse Example to create an instance using the builder pattern
ProjectCategoryRecommendationPagedQueryResponseBuilder Example to create an instance using the builder pattern
ProjectCategoryRecommendationPagedQueryResponse
ProjectChangeBusinessUnitStatusOnCreationAction Example to create an instance using the builder pattern
ProjectChangeBusinessUnitStatusOnCreationActionBuilder Example to create an instance using the builder pattern
ProjectChangeBusinessUnitStatusOnCreationAction
 
ProjectChangeCartsConfigurationAction Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationActionBuilder Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationAction
 
ProjectChangeCountriesAction Example to create an instance using the builder pattern
ProjectChangeCountriesActionBuilder Example to create an instance using the builder pattern
ProjectChangeCountriesAction
 
ProjectChangeCountryTaxRateFallbackEnabledAction Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledActionBuilder Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledAction
 
ProjectChangeCurrenciesAction Example to create an instance using the builder pattern
ProjectChangeCurrenciesActionBuilder Example to create an instance using the builder pattern
ProjectChangeCurrenciesAction
 
Removing a language used by a Store returns a LanguageUsedInStores error.
ProjectChangeLanguagesActionBuilder Example to create an instance using the builder pattern
Removing a language used by a Store returns a LanguageUsedInStores error.
 
ProjectChangeMessagesConfigurationAction Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationActionBuilder Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationAction
 
ProjectChangeNameAction Example to create an instance using the builder pattern
ProjectChangeNameActionBuilder Example to create an instance using the builder pattern
ProjectChangeNameAction
 
ProjectChangeOrderSearchStatusAction Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusActionBuilder Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusAction
 
ProjectChangeProductSearchIndexingEnabledAction Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledActionBuilder Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledAction
 
ProjectChangeShoppingListsConfigurationAction Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationActionBuilder Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationAction
 
Project
ProjectionselectingTrait
Returned when the languages set for a Store are not supported by the Project.
ProjectNotConfiguredForLanguagesErrorBuilder Example to create an instance using the builder pattern
Returned when the languages set for a Store are not supported by the Project.
 
 
 
 
 
 
 
ProjectSetBusinessUnitAssociateRoleOnCreationAction Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationActionBuilder Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationAction
 
ProjectSetExternalOAuthAction Example to create an instance using the builder pattern
ProjectSetExternalOAuthActionBuilder Example to create an instance using the builder pattern
ProjectSetExternalOAuthAction
 
ProjectSetShippingRateInputTypeAction Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeActionBuilder Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeAction
 
ProjectUpdate Example to create an instance using the builder pattern
ProjectUpdateAction Example to create a subtype instance using the builder pattern
ProjectUpdateActionBuilder
ProjectUpdateAction
 
ProjectUpdateBuilder Example to create an instance using the builder pattern
ProjectUpdate
 
Change triggered by the Publish update action.
PublishChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Publish update action.
 
 
QueryComplexityLimitExceededError Example to create an instance using the builder pattern
QueryComplexityLimitExceededErrorBuilder Example to create an instance using the builder pattern
QueryComplexityLimitExceededError
 
Table of content
  • Querying the API
 
 
QueryPrice Example to create an instance using the builder pattern
QueryPriceBuilder Example to create an instance using the builder pattern
QueryPrice
 
Returned when the query times out.
QueryTimedOutErrorBuilder Example to create an instance using the builder pattern
Returned when the query times out.
 
QueryTrait
 
Implementation of a Queue to limit the number of concurrent requests handled by the client
Middleware to limit the number of concurrent request using a Queue
Quote Example to create an instance using the builder pattern
QuoteBuilder Example to create an instance using the builder pattern
Changes the owner of a Quote to a different Customer.
QuoteChangeCustomerActionBuilder Example to create an instance using the builder pattern
Changes the owner of a Quote to a different Customer.
 
QuoteChangeQuoteStateAction Example to create an instance using the builder pattern
QuoteChangeQuoteStateActionBuilder Example to create an instance using the builder pattern
QuoteChangeQuoteStateAction
 
Generated after a successful Create Quote request.
QuoteCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
Generated after a successful Create Quote request.
QuoteCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
 
 
Generated after a successful Change Customer update action.
QuoteCustomerChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
Generated after a successful Change Customer update action.
QuoteCustomerChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
 
 
Generated after a successful Delete Quote request.
QuoteDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
Generated after a successful Delete Quote request.
QuoteDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
 
 
QuoteDraft Example to create an instance using the builder pattern
QuoteDraftBuilder Example to create an instance using the builder pattern
QuoteDraft
 
Quote
QuoteLabel Example to create an instance using the builder pattern
QuoteLabelBuilder Example to create an instance using the builder pattern
QuoteLabel
 
PagedQueryResult with results containing an array of Quote.
QuotePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Quote.
 
 
Reference to a Quote.
QuoteReferenceBuilder Example to create an instance using the builder pattern
Reference to a Quote.
 
QuoteRequest Example to create an instance using the builder pattern
QuoteRequestBuilder Example to create an instance using the builder pattern
Changes the owner of a Quote Request to a different Customer.
QuoteRequestChangeCustomerActionBuilder Example to create an instance using the builder pattern
Changes the owner of a Quote Request to a different Customer.
 
Transitions the Quote Request to a different state.
QuoteRequestChangeQuoteRequestStateActionBuilder Example to create an instance using the builder pattern
Transitions the Quote Request to a different state.
 
Generated after a successful Create Quote Request request.
QuoteRequestCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Quote Request request.
Generated after a successful Create Quote Request request.
QuoteRequestCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Quote Request request.
 
 
Generated after a successful Change Customer update action.
QuoteRequestCustomerChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
Generated after a successful Change Customer update action.
QuoteRequestCustomerChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
 
 
Generated after a successful Delete Quote Request request.
QuoteRequestDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Quote Request request.
Generated after a successful Delete Quote Request request.
QuoteRequestDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Quote Request request.
 
 
QuoteRequestDraft Example to create an instance using the builder pattern
QuoteRequestDraftBuilder Example to create an instance using the builder pattern
QuoteRequestDraft
 
QuoteRequest
QuoteRequestLabel Example to create an instance using the builder pattern
QuoteRequestLabelBuilder Example to create an instance using the builder pattern
QuoteRequestLabel
PagedQueryResult with results containing an array of QuoteRequest.
QuoteRequestPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of QuoteRequest.
 
 
Represents the Buyer requesting renegotiation for a Quote.
QuoteRequestQuoteRenegotiationActionBuilder Example to create an instance using the builder pattern
Represents the Buyer requesting renegotiation for a Quote.
 
Reference to a QuoteRequest.
QuoteRequestReferenceBuilder Example to create an instance using the builder pattern
Reference to a QuoteRequest.
 
ResourceIdentifier to a QuoteRequest.
QuoteRequestResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a QuoteRequest.
 
QuoteRequestSetCustomFieldAction Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldActionBuilder Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldAction
 
QuoteRequestSetCustomTypeAction Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeActionBuilder Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeAction
 
Predefined states tracking the status of the Quote Request in the negotiation process.
QuoteRequestState
possible values of QuoteRequestState
possible values of QuoteRequestState
Generated after a successful Change Quote Request State update action.
QuoteRequestStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Quote Request State update action.
Generated after a successful Change Quote Request State update action.
QuoteRequestStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Quote Request State update action.
 
 
Generated after a successful Transition State update action.
QuoteRequestStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
QuoteRequestStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
If the existing State has set transitions, there must be a direct transition to the new State.
QuoteRequestTransitionStateActionBuilder Example to create an instance using the builder pattern
If the existing State has set transitions, there must be a direct transition to the new State.
 
QuoteRequestUpdate Example to create an instance using the builder pattern
QuoteRequestUpdateAction Example to create a subtype instance using the builder pattern
QuoteRequestUpdateActionBuilder
QuoteRequestUpdateAction
 
QuoteRequestUpdateBuilder Example to create an instance using the builder pattern
QuoteRequestUpdate
 
ResourceIdentifier to a Quote.
QuoteResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Quote.
 
QuoteSetCustomFieldAction Example to create an instance using the builder pattern
QuoteSetCustomFieldActionBuilder Example to create an instance using the builder pattern
QuoteSetCustomFieldAction
 
QuoteSetCustomTypeAction Example to create an instance using the builder pattern
QuoteSetCustomTypeActionBuilder Example to create an instance using the builder pattern
QuoteSetCustomTypeAction
 
Predefined states tracking the status of the Quote.
QuoteState
possible values of QuoteState
possible values of QuoteState
Generated after a successful Change Quote State update action.
QuoteStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Quote State update action.
Generated after a successful Change Quote State update action.
QuoteStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Quote State update action.
 
 
Generated after a successful Transition State update action.
QuoteStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
QuoteStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
If the existing State has set transitions, there must be a direct transition to the new State.
QuoteTransitionStateActionBuilder Example to create an instance using the builder pattern
If the existing State has set transitions, there must be a direct transition to the new State.
 
QuoteUpdate Example to create an instance using the builder pattern
QuoteUpdateAction Example to create a subtype instance using the builder pattern
QuoteUpdateActionBuilder
QuoteUpdateAction
 
QuoteUpdateBuilder Example to create an instance using the builder pattern
QuoteUpdate
 
RangeFacetResult Example to create an instance using the builder pattern
RangeFacetResultBuilder Example to create an instance using the builder pattern
RangeFacetResult
 
Captures the differences between the previous and next version of a resource.
RecordBuilder Example to create an instance using the builder pattern
Captures the differences between the previous and next version of a resource.
PagedQueryResult with results containing an array of Record.
RecordPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Record.
Interface of a resource with an ID and version
A Reference represents a loose reference to another resource in the same Project identified by its id.
Reference Example to create an instance using the builder pattern
Reference Example to create a subtype instance using the builder pattern
This type represents an attribute whose value is a key reference.
ReferenceAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a key reference.
ReferenceBuilder
ReferenceBuilder Example to create an instance using the builder pattern
ReferenceBuilder
 
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
ReferencedResourceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
 
Returned when a resource cannot be deleted because it is being referenced by another resource.
ReferenceExistsErrorBuilder Example to create an instance using the builder pattern
Returned when a resource cannot be deleted because it is being referenced by another resource.
 
A field with a reference value.
ReferenceFieldBuilder Example to create an instance using the builder pattern
A field with a reference value.
A Reference represents a loose reference to another resource in the same Project identified by its id.
Reference
Reference
 
 
This type represents an attribute whose value is a set of references.
ReferenceSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of references.
A field with a reference set value.
ReferenceSetFieldBuilder Example to create an instance using the builder pattern
A field with a reference set value.
The type of the referenced resource.
possible values of ReferenceType
Type of resource the value should reference.
ReferenceTypeId
ReferenceTypeId
possible values of ReferenceTypeId
possible values of ReferenceTypeId
possible values of ReferenceTypeId
 
 
Change triggered by the Remove Address update action.
RemoveAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Address update action.
Change triggered by the following update actions:
RemoveAssetChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Remove AttributeDefinition update action.
RemoveAttributeDefinitionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove AttributeDefinition update action.
Change triggered by the Remove Billing Address ID update action.
RemoveBillingAddressIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Billing Address ID update action.
Change triggered by the Remove Roles update action.
RemoveChannelRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Roles update action.
Change triggered by the Remove CustomLineItem update action.
RemoveCustomLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove CustomLineItem update action.
RemoveDeliveryDraft Example to create an instance using the builder pattern
RemoveDeliveryDraftBuilder Example to create an instance using the builder pattern
RemoveDeliveryDraft
Change triggered by the Remove Delivery update action.
RemoveDeliveryItemsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Delivery update action.
Change triggered by the Remove DiscountCode update action.
RemoveDiscountCodeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove DiscountCode update action.
Change triggered by the Remove EnumValues from AttributeDefinition update action.
RemoveEnumValuesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove EnumValues from AttributeDefinition update action.
Change triggered by the Remove FieldDefinition update action.
RemoveFieldDefinitionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove FieldDefinition update action.
Change triggered by the Remove from Category update action.
RemoveFromCategoryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove from Category update action.
Change triggered by the Remove Image update action.
RemoveImageChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Image update action.
Change triggered by the Remove Item Shipping Address update action.
RemoveItemShippingAddressesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Item Shipping Address update action.
Change triggered by the Remove EnumValues from AttributeDefinition update action.
RemoveLocalizedEnumValuesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove EnumValues from AttributeDefinition update action.
Change triggered by the Remove Location update action.
RemoveLocationChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Location update action.
Change triggered by the Remove Parcel From Delivery update action.
RemoveOrderLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Parcel From Delivery update action.
Change triggered by the following update actions:
RemoveParcelFromDeliveryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
RemoveParcelFromDeliveryDraft Example to create an instance using the builder pattern
RemoveParcelFromDeliveryDraftBuilder Example to create an instance using the builder pattern
RemoveParcelFromDeliveryDraft
Change triggered by the following update actions:
RemovePaymentChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Remove Embedded Price update action.
RemovePriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Embedded Price update action.
Change triggered by the Remove Product update action.
RemoveProductChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Product update action.
Change triggered by the Update CustomObject request when an existing property is removed.
RemovePropertyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when an existing property is removed.
Change triggered by the Remove Shipping Address ID update action.
RemoveShippingAddressIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove Shipping Address ID update action.
Change triggered by the Remove ShoppingListLineItem update action.
RemoveShoppingListLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove ShoppingListLineItem update action.
Change triggered by the Remove State roles update action.
RemoveStateRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove State roles update action.
Change triggered by the Remove TaxRate update action.
RemoveTaxRateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove TaxRate update action.
Change triggered by the Remove TextLineItem update action.
RemoveTextLineItemChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove TextLineItem update action.
Change triggered by the Remove ProductVariant update action.
RemoveVariantChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Remove ProductVariant update action.
 
Used for replicating an existing Cart or Order.
ReplicaCartDraftBuilder Example to create an instance using the builder pattern
Used for replicating an existing Cart or Order.
Deprecated.
 
ReplicaMyCartDraft Example to create an instance using the builder pattern
ReplicaMyCartDraftBuilder Example to create an instance using the builder pattern
ReplicaMyCartDraft
 
 
Returned when a value is not defined for a required field.
A required field is missing a value.
RequiredFieldErrorBuilder Example to create an instance using the builder pattern
RequiredFieldErrorBuilder Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
A required field is missing a value.
 
Reservation Example to create an instance using the builder pattern
ReservationBuilder Example to create an instance using the builder pattern
Reservation
Deprecated.
Deprecated.
This payload is sent for a ChangeSubscription when a resource is created.
ResourceCreatedDeliveryPayloadBuilder Example to create an instance using the builder pattern
This payload is sent for a ChangeSubscription when a resource is created.
 
ResourceCreationError Example to create an instance using the builder pattern
ResourceCreationErrorBuilder Example to create an instance using the builder pattern
ResourceCreationError
Deprecated.
Deprecated.
This payload is sent for a ChangeSubscription when a resource is deleted.
ResourceDeletedDeliveryPayloadBuilder Example to create an instance using the builder pattern
This payload is sent for a ChangeSubscription when a resource is deleted.
 
ResourceDeletionError Example to create an instance using the builder pattern
ResourceDeletionErrorBuilder Example to create an instance using the builder pattern
ResourceDeletionError
Interface of a resource with an ID and version
Draft type to create a Reference or a KeyReference to a resource.
ResourceIdentifierBuilder
Draft type to create a Reference or a KeyReference to a resource.
 
Returned when the resource addressed by the request URL does not exist.
ResourceNotFoundError Example to create an instance using the builder pattern
ResourceNotFoundErrorBuilder Example to create an instance using the builder pattern
ResourceNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when the resource addressed by the request URL does not exist.
ResourceNotFoundError
 
 
Returned when the resource exceeds the maximum allowed size of 16 MB.
ResourceSizeLimitExceededErrorBuilder Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
 
IDs indicating the customizable resources and data types.
IDs indicating the customizable resources and data types.
possible values of ResourceTypeId
possible values of ResourceTypeId
 
 
Deprecated.
Deprecated.
This payload is sent for a ChangeSubscription when a resource is updated.
ResourceUpdatedDeliveryPayloadBuilder Example to create an instance using the builder pattern
This payload is sent for a ChangeSubscription when a resource is updated.
 
ResourceUpdateError Example to create an instance using the builder pattern
ResourceUpdateErrorBuilder Example to create an instance using the builder pattern
ResourceUpdateError
Interface to deserialize a response to a specified output type
An image URL and the product variants it is contained in.
ResultItemBuilder Example to create an instance using the builder pattern
An image URL and the product variants it is contained in.
Handler functions to retry single requests.
Implementation for a retry of a requests upon configured response status codes
Middleware for retrying of a requests upon configured response status codes and/or exceptions
ReturnInfo Example to create an instance using the builder pattern
ReturnInfo Example to create an instance using the builder pattern
ReturnInfo Example to create an instance using the builder pattern
Generated after a successful Add Return Info update action.
ReturnInfoAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Return Info update action.
Generated after a successful Add Return Info update action.
ReturnInfoAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Return Info update action.
 
 
ReturnInfoBuilder Example to create an instance using the builder pattern
ReturnInfoBuilder Example to create an instance using the builder pattern
ReturnInfoBuilder Example to create an instance using the builder pattern
ReturnInfoDraft Example to create an instance using the builder pattern
ReturnInfoDraftBuilder Example to create an instance using the builder pattern
ReturnInfoDraft
 
ReturnInfo
ReturnInfo
ReturnInfo
 
Generated after a successful Set Return Info update action on Orders and Order Edits.
ReturnInfoSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Return Info update action on Orders and Order Edits.
Generated after a successful Set Return Info update action on Orders and Order Edits.
ReturnInfoSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Return Info update action on Orders and Order Edits.
 
 
ReturnItem Example to create a subtype instance using the builder pattern
ReturnItem Example to create an instance using the builder pattern
ReturnItemBuilder
ReturnItemBuilder Example to create an instance using the builder pattern
ReturnItemDraft Example to create an instance using the builder pattern
ReturnItemDraft Example to create an instance using the builder pattern
ReturnItemDraftBuilder Example to create an instance using the builder pattern
ReturnItemDraftBuilder Example to create an instance using the builder pattern
ReturnItemDraft
ReturnItemDraft
 
ReturnItem
ReturnItem
 
ReturnPaymentState
ReturnPaymentState
possible values of ReturnPaymentState
possible values of ReturnPaymentState
ReturnShipmentState
ReturnShipmentState
Maps to ReturnItem.shipmentState
possible values of ReturnShipmentState
possible values of ReturnShipmentState
possible values of ReturnShipmentState
Review Example to create an instance using the builder pattern
ReviewBuilder Example to create an instance using the builder pattern
Generated after a successful Create Review request.
ReviewCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Review request.
Generated after a successful Create Review request.
ReviewCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Review request.
 
 
When creating a new Review, at least one of title, text or rating should be set.
ReviewDraftBuilder Example to create an instance using the builder pattern
When creating a new Review, at least one of title, text or rating should be set.
 
Review
ReviewLabel Example to create an instance using the builder pattern
ReviewLabelBuilder Example to create an instance using the builder pattern
ReviewLabel
Deprecated.
 
ReviewPagedQueryResponse Example to create an instance using the builder pattern
ReviewPagedQueryResponseBuilder Example to create an instance using the builder pattern
ReviewPagedQueryResponse
 
 
Generated after a successful Set Rating update action.
ReviewRatingSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Rating update action.
Generated after a successful Set Rating update action.
ReviewRatingSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Rating update action.
 
 
ReviewRatingStatistics Example to create an instance using the builder pattern
ReviewRatingStatistics Example to create an instance using the builder pattern
ReviewRatingStatisticsBuilder Example to create an instance using the builder pattern
ReviewRatingStatisticsBuilder Example to create an instance using the builder pattern
ReviewRatingStatistics
ReviewRatingStatistics
 
Reference to a Review.
ReviewReferenceBuilder Example to create an instance using the builder pattern
Reference to a Review.
 
ResourceIdentifier to a Review.
ReviewResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Review.
 
ReviewSetAuthorNameAction Example to create an instance using the builder pattern
ReviewSetAuthorNameActionBuilder Example to create an instance using the builder pattern
ReviewSetAuthorNameAction
 
ReviewSetCustomerAction Example to create an instance using the builder pattern
ReviewSetCustomerActionBuilder Example to create an instance using the builder pattern
ReviewSetCustomerAction
 
ReviewSetCustomFieldAction Example to create an instance using the builder pattern
ReviewSetCustomFieldActionBuilder Example to create an instance using the builder pattern
ReviewSetCustomFieldAction
 
ReviewSetCustomTypeAction Example to create an instance using the builder pattern
ReviewSetCustomTypeActionBuilder Example to create an instance using the builder pattern
ReviewSetCustomTypeAction
 
ReviewSetKeyAction Example to create an instance using the builder pattern
ReviewSetKeyActionBuilder Example to create an instance using the builder pattern
ReviewSetKeyAction
 
ReviewSetLocaleAction Example to create an instance using the builder pattern
ReviewSetLocaleActionBuilder Example to create an instance using the builder pattern
ReviewSetLocaleAction
 
This update action produces the ReviewRatingSet Message.
ReviewSetRatingActionBuilder Example to create an instance using the builder pattern
This update action produces the ReviewRatingSet Message.
 
ReviewSetTargetAction Example to create an instance using the builder pattern
ReviewSetTargetActionBuilder Example to create an instance using the builder pattern
ReviewSetTargetAction
 
ReviewSetTextAction Example to create an instance using the builder pattern
ReviewSetTextActionBuilder Example to create an instance using the builder pattern
ReviewSetTextAction
 
ReviewSetTitleAction Example to create an instance using the builder pattern
ReviewSetTitleActionBuilder Example to create an instance using the builder pattern
ReviewSetTitleAction
 
Generated after a successful Transition State update action.
ReviewStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
ReviewStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
Transition to a new State.
ReviewTransitionStateActionBuilder Example to create an instance using the builder pattern
Transition to a new State.
 
ReviewUpdate Example to create an instance using the builder pattern
ReviewUpdateAction Example to create a subtype instance using the builder pattern
ReviewUpdateActionBuilder
ReviewUpdateAction
 
ReviewUpdateBuilder Example to create an instance using the builder pattern
ReviewUpdate
 
 
Determines how monetary values are rounded.
RoundingMode
Maps to Order.taxRoundingMode.
possible values of RoundingMode
possible values of RoundingMode
possible values of RoundingMode
Scoped Price is contained in a ProductVariant which is returned in response to a Product Projection Search request when Scoped Price Search is used.
ScopedPriceBuilder Example to create an instance using the builder pattern
Scoped Price is contained in a ProductVariant which is returned in response to a Product Projection Search request when Scoped Price Search is used.
 
ScoreShippingRateInput Example to create an instance using the builder pattern
ScoreShippingRateInput Example to create an instance using the builder pattern
ScoreShippingRateInputBuilder Example to create an instance using the builder pattern
ScoreShippingRateInputBuilder Example to create an instance using the builder pattern
ScoreShippingRateInputDraft Example to create an instance using the builder pattern
ScoreShippingRateInputDraftBuilder Example to create an instance using the builder pattern
ScoreShippingRateInputDraft
 
ScoreShippingRateInput
ScoreShippingRateInput
 
Returned when the indexing of Product information is deactivated in a Project.
SearchDeactivatedErrorBuilder Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
 
Returned when a search query could not be completed due to an unexpected failure.
SearchExecutionFailureErrorBuilder Example to create an instance using the builder pattern
Returned when a search query could not be completed due to an unexpected failure.
 
Returned when a search facet path could not be found.
SearchFacetPathNotFoundErrorBuilder Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
 
Controls indexing of resources to be provided on high performance read-only search endpoints.
SearchIndexingConfigurationBuilder Example to create an instance using the builder pattern
Controls indexing of resources to be provided on high performance read-only search endpoints.
 
Status of resource indexing.
possible values of SearchIndexingConfigurationStatus
SearchIndexingConfigurationValues Example to create an instance using the builder pattern
SearchIndexingConfigurationValuesBuilder Example to create an instance using the builder pattern
SearchIndexingConfigurationValues
 
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
SearchIndexingInProgressErrorBuilder Example to create an instance using the builder pattern
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
 
SearchKeyword Example to create an instance using the builder pattern
SearchKeyword Example to create an instance using the builder pattern
SearchKeyword Example to create an instance using the builder pattern
SearchKeywordBuilder Example to create an instance using the builder pattern
SearchKeywordBuilder Example to create an instance using the builder pattern
SearchKeywordBuilder Example to create an instance using the builder pattern
SearchKeyword
SearchKeyword
SearchKeyword
 
Search keywords are JSON objects primarily used by Product Suggestions, but are also considered for a full text search.
SearchKeywords Example to create an instance using the builder pattern
Search keywords are primarily used by the suggester but are also considered for the full-text search.
SearchKeywordsBuilder Example to create an instance using the builder pattern
SearchKeywordsBuilder Example to create an instance using the builder pattern
SearchKeywordsBuilder Example to create an instance using the builder pattern
Search keywords are JSON objects primarily used by Product Suggestions, but are also considered for a full text search.
SearchKeywords
Search keywords are primarily used by the suggester but are also considered for the full-text search.
 
Secured_by_manage_customersTrait
Secured_by_manage_import_containersTrait
Secured_by_manage_ordersTrait
Secured_by_manage_productsTrait
Secured_by_manage_standalone_pricesTrait
Secured_by_manage_typesTrait
Secured_by_view_customersTrait
Secured_by_view_import_containersTrait
Secured_by_view_ordersTrait
Secured_by_view_productsTrait
Defines which matching items are to be discounted.
SelectionMode
possible values of SelectionMode
possible values of SelectionMode
Returned when a Discount predicate or API Extension predicate is not semantically correct.
SemanticErrorErrorBuilder Example to create an instance using the builder pattern
Returned when a Discount predicate or API Extension predicate is not semantically correct.
 
Table of content
  • Serialization
    • Customization
    • Date and time attributes
 
Implementation of a non executable ApiHttpClient
 
 
 
 
 
 
 
 
 
 
Change triggered by the Set Address update action.
SetAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Address update action.
Change triggered by the following update actions:
SetAnonymousIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered automatically due to a user-initiated change.
SetApplicationVersionChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
Change triggered by the following update actions:
SetAssetCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetAssetCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetAssetDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetAssetKeyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetAssetSourcesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetAssetTagsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Attribute update action.
SetAttributeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Attribute update action.
Change triggered by the Set AuthenticationMode update action.
SetAuthenticationModeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set AuthenticationMode update action.
Change triggered by the Set Author Name update action.
SetAuthorNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Author Name update action.
Change triggered by the following update actions:
SetBillingAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCartClassificationShippingRateInputValue Example to create an instance using the builder pattern
SetCartClassificationShippingRateInputValueBuilder Example to create an instance using the builder pattern
SetCartClassificationShippingRateInputValue
Change triggered by the Set Cart Predicate update action.
SetCartPredicateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Cart Predicate update action.
SetCartScoreShippingRateInputValue Example to create an instance using the builder pattern
SetCartScoreShippingRateInputValueBuilder Example to create an instance using the builder pattern
SetCartScoreShippingRateInputValue
Change triggered by the Set Category Order Hint update action.
SetCategoryOrderHintChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Category Order Hint update action.
Change triggered by the Set Roles update action.
SetChannelRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Roles update action.
Change triggered by the Set Company Name update action.
SetCompanyNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Company Name update action.
Change triggered by the Set Countries update action.
SetCountriesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Countries update action.
Change triggered by the Set Country update action.
SetCountryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Country update action.
Change triggered by the following update actions:
SetCustomerChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetCustomerEmailChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set CustomerGroup update action.
SetCustomerGroupChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set CustomerGroup update action.
Change triggered by the following update actions:
SetCustomerIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Customer Number update action.
SetCustomerNumberChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Customer Number update action.
Change triggered by the following update actions:
SetCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetCustomLineItemCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetCustomLineItemCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set CustomLineItem Money update action.
SetCustomLineItemMoneyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem Money update action.
Change triggered by the following update actions:
SetCustomLineItemShippingDetailsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set CustomLineItem TaxAmount update action.
SetCustomLineItemTaxAmountChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem TaxAmount update action.
SetCustomLineItemTaxCategoryChange Example to create an instance using the builder pattern
SetCustomLineItemTaxCategoryChangeBuilder Example to create an instance using the builder pattern
SetCustomLineItemTaxCategoryChange
SetCustomLineItemTaxedPriceChange Example to create an instance using the builder pattern
SetCustomLineItemTaxedPriceChangeBuilder Example to create an instance using the builder pattern
SetCustomLineItemTaxedPriceChange
Change triggered by the Set CustomLineItem TaxRate update action.
SetCustomLineItemTaxRateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem TaxRate update action.
SetCustomLineItemTotalPriceChange Example to create an instance using the builder pattern
SetCustomLineItemTotalPriceChangeBuilder Example to create an instance using the builder pattern
SetCustomLineItemTotalPriceChange
Change triggered by the Set Custom ShippingMethod update action.
SetCustomShippingMethodChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Custom ShippingMethod update action.
Change triggered by the following update actions:
SetCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Date of Birth update action.
SetDateOfBirthChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Date of Birth update action.
Change triggered by the Set Default Billing Address update action.
SetDefaultBillingAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Default Billing Address update action.
Change triggered by the Set Default Shipping Address update action.
SetDefaultShippingAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Default Shipping Address update action.
Change triggered by the Set DeleteDaysAfterLastModification update action.
SetDeleteDaysAfterLastModificationChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set DeleteDaysAfterLastModification update action.
Change triggered by the following update actions:
SetDeliveryAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetDeliveryItemsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Discounted Embedded Price update action.
SetDiscountedPriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Discounted Embedded Price update action.
Change triggered by the Set Distribution Channels update action.
SetDistributionChannelsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Distribution Channels update action.
Change triggered by the Set ExpectedDelivery update action.
SetExpectedDeliveryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ExpectedDelivery update action.
Change triggered by the following update actions:
SetExternalIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set First Name update action.
SetFirstNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set First Name update action.
Change triggered by the Set GeoLocation update action.
SetGeoLocationChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set GeoLocation update action.
Change triggered by the Set Image Label update action.
SetImageLabelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Image Label update action.
Change triggered by the Set AttributeDefinition InputTip update action.
SetInputTipChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set AttributeDefinition InputTip update action.
Change triggered by the Set InterfaceId update action.
SetInterfaceIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set InterfaceId update action.
Change triggered automatically due to a user-initiated change.
SetIsValidChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
Change triggered by the following update actions:
SetKeyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by Set Languages update action.
SetLanguagesChangeBuilder Example to create an instance using the builder pattern
Change triggered by Set Languages update action.
Change triggered by Set Last Name update action.
SetLastNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by Set Last Name update action.
SetLineItemDeactivatedAtChange Example to create an instance using the builder pattern
SetLineItemDeactivatedAtChangeBuilder Example to create an instance using the builder pattern
SetLineItemDeactivatedAtChange
SetLineItemDiscountedPriceChange Example to create an instance using the builder pattern
SetLineItemDiscountedPriceChangeBuilder Example to create an instance using the builder pattern
SetLineItemDiscountedPriceChange
SetLineItemDiscountedPricePerQuantityChange Example to create an instance using the builder pattern
SetLineItemDiscountedPricePerQuantityChangeBuilder Example to create an instance using the builder pattern
SetLineItemDiscountedPricePerQuantityChange
Change triggered by the Set LineItem DistributionChannel update action.
SetLineItemDistributionChannelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set LineItem DistributionChannel update action.
Change triggered by the Set LineItem Price update action.
SetLineItemPriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set LineItem Price update action.
SetLineItemProductKeyChange Example to create an instance using the builder pattern
SetLineItemProductKeyChangeBuilder Example to create an instance using the builder pattern
SetLineItemProductKeyChange
Change triggered automatically due to a user-initiated change.
SetLineItemProductSlugChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
Change triggered by the following update actions:
SetLineItemShippingDetailsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set LineItem TaxAmount update action.
SetLineItemTaxAmountChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set LineItem TaxAmount update action.
SetLineItemTaxedPriceChange Example to create an instance using the builder pattern
SetLineItemTaxedPriceChangeBuilder Example to create an instance using the builder pattern
SetLineItemTaxedPriceChange
Change triggered by the Set LineItemTaxRate update action.
SetLineItemTaxRateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set LineItemTaxRate update action.
Change triggered by the Set LineItemTotalPrice update action.
SetLineItemTotalPriceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set LineItemTotalPrice update action.
Change triggered by the following update actions:
SetLocaleChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetLocalizedDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Max Applications update action.
SetMaxApplicationsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Max Applications update action.
Change triggered by the Set Max Applications Per Customer update action.
SetMaxApplicationsPerCustomerChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Max Applications Per Customer update action.
Change triggered by the following update actions:
SetMetaDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetMetaKeywordsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetMetaTitleChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set MethodInfoInterface update action.
SetMethodInfoInterfaceChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoInterface update action.
Change triggered by the Set MethodInfoInterface update action.
SetMethodInfoMethodChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoInterface update action.
Change triggered by the Set MethodInfoName update action.
SetMethodInfoNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoName update action.
Change triggered by the Set Middle Name update action.
SetMiddleNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Middle Name update action.
Change triggered by the following update actions:
SetNameChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetOrderLineItemCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetOrderLineItemCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetOrderNumberChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetOrderTaxedPriceChange Example to create an instance using the builder pattern
SetOrderTaxedPriceChangeBuilder Example to create an instance using the builder pattern
SetOrderTaxedPriceChange
Change triggered automatically due to a user-initiated change.
SetOrderTotalPriceChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
Change triggered by the Set OrderTotalTax update action.
SetOrderTotalTaxChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set OrderTotalTax update action.
Change triggered by the following update actions:
SetParcelItemsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetParcelMeasurementsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetParcelTrackingDataChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Prices update action.
SetPricesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Prices update action.
Change triggered automatically by the Add Product or Remove Product update action.
SetProductCountChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically by the Add Product or Remove Product update action.
Change triggered by the Set Price CustomField update action.
SetProductPriceCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Price CustomField update action.
Change triggered by the Set Price Custom Type update action.
SetProductPriceCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Price Custom Type update action.
Change triggered by the Set Product Selections update action.
SetProductSelectionsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Product Selections update action.
Change triggered by the Set ProductVariant Key update action.
SetProductVariantKeyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ProductVariant Key update action.
Change triggered by the Update CustomObject request when an existing property is updated.
SetPropertyChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when an existing property is updated.
Change triggered by the following update actions:
SetPurchaseOrderNumberChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Rating update action.
SetRatingChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Rating update action.
SetReservationsChange Example to create an instance using the builder pattern
SetReservationsChangeBuilder Example to create an instance using the builder pattern
SetReservationsChange
Change triggered by the Set RestockableInDays update action.
SetRestockableInDaysChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set RestockableInDays update action.
Change triggered by the following update actions:
SetReturnPaymentStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetReturnShipmentStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Salutation update action.
SetSalutationChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Salutation update action.
Change triggered by the Set SearchKeywords update action.
SetSearchKeywordsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set SearchKeywords update action.
Change triggered by the Set Seller Comment update action.
SetSellerCommentChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Seller Comment update action.
Change triggered by the following update actions:
SetShippingAddressChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetShippingInfoPriceChange Example to create an instance using the builder pattern
SetShippingInfoPriceChangeBuilder Example to create an instance using the builder pattern
SetShippingInfoPriceChange
SetShippingInfoTaxedPriceChange Example to create an instance using the builder pattern
SetShippingInfoTaxedPriceChangeBuilder Example to create an instance using the builder pattern
SetShippingInfoTaxedPriceChange
Change triggered by the Set ShippingMethod update action.
SetShippingMethodChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod update action.
Change triggered by the Set ShippingMethod TaxAmount update action.
SetShippingMethodTaxAmountChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod TaxAmount update action.
Change triggered by the Set ShippingMethod TaxRate update action.
SetShippingMethodTaxRateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod TaxRate update action.
SetShippingRateChange Example to create an instance using the builder pattern
SetShippingRateChangeBuilder Example to create an instance using the builder pattern
SetShippingRateChange
Change triggered by the Set Shipping Rate Input update action.
SetShippingRateInputChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Shipping Rate Input update action.
Change triggered by the Set ShoppingListLineItem Custom Field update action.
SetShoppingListLineItemCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ShoppingListLineItem Custom Field update action.
Change triggered by the Set ShoppingListLineItem Custom Type update action.
SetShoppingListLineItemCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set ShoppingListLineItem Custom Type update action.
Change triggered by the Set SKU update action.
SetSkuChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set SKU update action.
Change triggered by the Set Slug update action.
SetSlugChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Slug update action.
Change triggered by the Set State roles update action.
SetStateRolesChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set State roles update action.
Change triggered by the Set StatusInterfaceCode update action.
SetStatusInterfaceCodeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set StatusInterfaceCode update action.
Change triggered by the Set StatusInterfaceText update action.
SetStatusInterfaceTextChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set StatusInterfaceText update action.
Change triggered by the following update actions:
SetStoreChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Stores update action.
SetStoresChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Stores update action.
Change triggered by the Set SupplyChannel update action.
SetSupplyChannelChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set SupplyChannel update action.
Change triggered by the Set Supply Channels update action.
SetSupplyChannelsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Supply Channels update action.
Change triggered by the Set Target update action.
SetTargetChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Target update action.
Change triggered by the Set TaxCategory update action.
SetTaxCategoryChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set TaxCategory update action.
Change triggered by the Set Text update action.
SetTextChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Text update action.
Change triggered by the Set TextLineItem CustomField update action.
SetTextLineItemCustomFieldChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem CustomField update action.
Change triggered by the Set TextLineItem Custom Type update action.
SetTextLineItemCustomTypeChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem Custom Type update action.
Change triggered by the Set TextLineItem Description update action.
SetTextLineItemDescriptionChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem Description update action.
Change triggered by the following update actions:
SetTitleChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Transitions update action.
SetTransitionsChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Transitions update action.
Change triggered by the following update actions:
SetValidFromAndUntilChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
SetValidFromChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Set Valid To update action.
SetValidToChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Valid To update action.
Change triggered by the following update actions:
SetValidUntilChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the Update CustomObject request when a value of a property is updated.
SetValueChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when a value of a property is updated.
Change triggered automatically when an InventoryEntry associated with a Product changes.
SetVariantAvailabilityChangeBuilder Example to create an instance using the builder pattern
Change triggered automatically when an InventoryEntry associated with a Product changes.
Change triggered by the Set Vat ID update action.
SetVatIdChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Set Vat ID update action.
ShipmentState
ShipmentState
Maps to Order.shipmentState.
possible values of ShipmentState
possible values of ShipmentState
possible values of ShipmentState
Shipping Example to create an instance using the builder pattern
ShippingBuilder Example to create an instance using the builder pattern
Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
ShippingDraftBuilder Example to create an instance using the builder pattern
Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
 
Shipping
ShippingInfo Example to create an instance using the builder pattern
ShippingInfoBuilder Example to create an instance using the builder pattern
ShippingInfo
ShippingInfoImportDraft Example to create an instance using the builder pattern
Maps to an order's shippingInfo property.
ShippingInfoImportDraftBuilder Example to create an instance using the builder pattern
ShippingInfoImportDraftBuilder Example to create an instance using the builder pattern
ShippingInfoImportDraft
Maps to an order's shippingInfo property.
 
 
ShippingMethod Example to create an instance using the builder pattern
ShippingMethodAddShippingRateAction Example to create an instance using the builder pattern
ShippingMethodAddShippingRateActionBuilder Example to create an instance using the builder pattern
ShippingMethodAddShippingRateAction
 
ShippingMethodAddZoneAction Example to create an instance using the builder pattern
ShippingMethodAddZoneActionBuilder Example to create an instance using the builder pattern
ShippingMethodAddZoneAction
 
ShippingMethodBuilder Example to create an instance using the builder pattern
ShippingMethodChangeIsDefaultAction Example to create an instance using the builder pattern
ShippingMethodChangeIsDefaultActionBuilder Example to create an instance using the builder pattern
ShippingMethodChangeIsDefaultAction
 
ShippingMethodChangeNameAction Example to create an instance using the builder pattern
ShippingMethodChangeNameActionBuilder Example to create an instance using the builder pattern
ShippingMethodChangeNameAction
 
ShippingMethodChangeTaxCategoryAction Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryActionBuilder Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryAction
 
ShippingMethodChangeValue Example to create an instance using the builder pattern
ShippingMethodChangeValueBuilder Example to create an instance using the builder pattern
ShippingMethodChangeValue
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
ShippingMethodDoesNotMatchCartErrorBuilder Example to create an instance using the builder pattern
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
 
ShippingMethodDraft Example to create an instance using the builder pattern
ShippingMethodDraftBuilder Example to create an instance using the builder pattern
ShippingMethodDraft
 
ShippingMethod
References a shipping method by key.
ShippingMethodKeyReferenceBuilder Example to create an instance using the builder pattern
References a shipping method by key.
 
PagedQueryResult with results containing an array of ShippingMethod.
ShippingMethodPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ShippingMethod.
 
 
Reference to a ShippingMethod.
ShippingMethodReferenceBuilder Example to create an instance using the builder pattern
Reference to a ShippingMethod.
 
ShippingMethodRemoveShippingRateAction Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateActionBuilder Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateAction
 
ShippingMethodRemoveZoneAction Example to create an instance using the builder pattern
ShippingMethodRemoveZoneActionBuilder Example to create an instance using the builder pattern
ShippingMethodRemoveZoneAction
 
ResourceIdentifier to a ShippingMethod.
ShippingMethodResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a ShippingMethod.
 
This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.
ShippingMethodSetCustomFieldActionBuilder Example to create an instance using the builder pattern
This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.
 
ShippingMethodSetCustomTypeAction Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeActionBuilder Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeAction
 
Deprecated.
Deprecated.
Deprecated.
Deprecated.
ShippingMethodSetKeyAction Example to create an instance using the builder pattern
ShippingMethodSetKeyActionBuilder Example to create an instance using the builder pattern
ShippingMethodSetKeyAction
 
ShippingMethodSetLocalizedDescriptionAction Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionActionBuilder Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionAction
 
ShippingMethodSetLocalizedNameAction Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameActionBuilder Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameAction
 
ShippingMethodSetPredicateAction Example to create an instance using the builder pattern
ShippingMethodSetPredicateActionBuilder Example to create an instance using the builder pattern
ShippingMethodSetPredicateAction
 
Determines whether a ShippingMethod is allowed for a Cart.
ShippingMethodState
possible values of ShippingMethodState
possible values of ShippingMethodState
ShippingMethodTaxAmountChangeValue Example to create an instance using the builder pattern
ShippingMethodTaxAmountChangeValueBuilder Example to create an instance using the builder pattern
ShippingMethodTaxAmountChangeValue
ShippingMethodUpdate Example to create an instance using the builder pattern
ShippingMethodUpdateAction Example to create a subtype instance using the builder pattern
ShippingMethodUpdateActionBuilder
ShippingMethodUpdateAction
 
ShippingMethodUpdateBuilder Example to create an instance using the builder pattern
ShippingMethodUpdate
 
ShippingMode
possible values of ShippingMode
 
ShippingRate Example to create an instance using the builder pattern
ShippingRate Example to create an instance using the builder pattern
ShippingRateBuilder Example to create an instance using the builder pattern
ShippingRateBuilder Example to create an instance using the builder pattern
ShippingRateDraft Example to create an instance using the builder pattern
ShippingRateDraft Example to create an instance using the builder pattern
ShippingRateDraftBuilder Example to create an instance using the builder pattern
ShippingRateDraftBuilder Example to create an instance using the builder pattern
ShippingRateDraft
ShippingRateDraft
 
ShippingRate
ShippingRate
ShippingRateInput Example to create a subtype instance using the builder pattern
ShippingRateInput Example to create a subtype instance using the builder pattern
ShippingRateInputBuilder
ShippingRateInputBuilder
Generic type holding specifc ShippingRateInputDraft types.
ShippingRateInputDraftBuilder
Generic type holding specifc ShippingRateInputDraft types.
 
ShippingRateInput
ShippingRateInput
 
ShippingRateInputType Example to create a subtype instance using the builder pattern
ShippingRateInputType
possible values of ShippingRateInputType
ShippingRateInputTypeBuilder
ShippingRateInputType
 
ShippingRatePriceTier Example to create a subtype instance using the builder pattern
ShippingRatePriceTier Example to create an instance using the builder pattern
ShippingRatePriceTier Example to create a subtype instance using the builder pattern
ShippingRatePriceTierBuilder
ShippingRatePriceTierBuilder Example to create an instance using the builder pattern
ShippingRatePriceTierBuilder
ShippingRatePriceTier
ShippingRatePriceTier
ShippingRatePriceTier
 
 
ShippingRateTierType
ShippingRateTierType
ShippingRateTierType
possible values of ShippingRateTierType
possible values of ShippingRateTierType
possible values of ShippingRateTierType
ShoppingList Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.
ShoppingListAddLineItemActionBuilder Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.
 
ShoppingListAddTextLineItemAction Example to create an instance using the builder pattern
ShoppingListAddTextLineItemActionBuilder Example to create an instance using the builder pattern
ShoppingListAddTextLineItemAction
 
ShoppingListBuilder Example to create an instance using the builder pattern
ShoppingListChangeLineItemQuantityAction Example to create an instance using the builder pattern
ShoppingListChangeLineItemQuantityActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeLineItemQuantityAction
 
ShoppingListChangeLineItemsOrderAction Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderAction
 
ShoppingListChangeNameAction Example to create an instance using the builder pattern
ShoppingListChangeNameActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeNameAction
 
ShoppingListChangeTextLineItemNameAction Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameAction
 
ShoppingListChangeTextLineItemQuantityAction Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityAction
 
ShoppingListChangeTextLineItemsOrderAction Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderActionBuilder Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderAction
 
ShoppingListDraft Example to create an instance using the builder pattern
ShoppingListDraftBuilder Example to create an instance using the builder pattern
ShoppingListDraft
 
ShoppingList
ShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.
ShoppingListLineItemBuilder Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.
ShoppingListLineItemDraftBuilder Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.
 
ShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.
 
ShoppingListLineItemValue Example to create an instance using the builder pattern
ShoppingListLineItemValueBuilder Example to create an instance using the builder pattern
ShoppingListLineItemValue
 
ShoppingListPagedQueryResponse Example to create an instance using the builder pattern
ShoppingListPagedQueryResponseBuilder Example to create an instance using the builder pattern
ShoppingListPagedQueryResponse
 
 
Reference to a ShoppingList.
ShoppingListReferenceBuilder Example to create an instance using the builder pattern
Reference to a ShoppingList.
 
ShoppingListRemoveLineItemAction Example to create an instance using the builder pattern
ShoppingListRemoveLineItemActionBuilder Example to create an instance using the builder pattern
ShoppingListRemoveLineItemAction
 
ShoppingListRemoveTextLineItemAction Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemActionBuilder Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemAction
 
ResourceIdentifier to a ShoppingList.
ShoppingListResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a ShoppingList.
 
ShoppingListsConfiguration Example to create an instance using the builder pattern
ShoppingListsConfigurationBuilder Example to create an instance using the builder pattern
ShoppingListsConfiguration
 
ShoppingListSetAnonymousIdAction Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdActionBuilder Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdAction
 
ShoppingListSetCustomerAction Example to create an instance using the builder pattern
ShoppingListSetCustomerActionBuilder Example to create an instance using the builder pattern
ShoppingListSetCustomerAction
 
ShoppingListSetCustomFieldAction Example to create an instance using the builder pattern
ShoppingListSetCustomFieldActionBuilder Example to create an instance using the builder pattern
ShoppingListSetCustomFieldAction
 
ShoppingListSetCustomTypeAction Example to create an instance using the builder pattern
ShoppingListSetCustomTypeActionBuilder Example to create an instance using the builder pattern
ShoppingListSetCustomTypeAction
 
ShoppingListSetDeleteDaysAfterLastModificationAction Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationAction
 
ShoppingListSetDescriptionAction Example to create an instance using the builder pattern
ShoppingListSetDescriptionActionBuilder Example to create an instance using the builder pattern
ShoppingListSetDescriptionAction
 
ShoppingListSetKeyAction Example to create an instance using the builder pattern
ShoppingListSetKeyActionBuilder Example to create an instance using the builder pattern
ShoppingListSetKeyAction
 
ShoppingListSetLineItemCustomFieldAction Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldAction
 
ShoppingListSetLineItemCustomTypeAction Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeAction
 
ShoppingListSetSlugAction Example to create an instance using the builder pattern
ShoppingListSetSlugActionBuilder Example to create an instance using the builder pattern
ShoppingListSetSlugAction
 
ShoppingListSetStoreAction Example to create an instance using the builder pattern
ShoppingListSetStoreActionBuilder Example to create an instance using the builder pattern
ShoppingListSetStoreAction
 
ShoppingListSetTextLineItemCustomFieldAction Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldAction
 
ShoppingListSetTextLineItemCustomTypeAction Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeAction
 
ShoppingListSetTextLineItemDescriptionAction Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionActionBuilder Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionAction
 
ShoppingListStoreSetMessagePayload Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayloadBuilder Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayload
 
ShoppingListUpdate Example to create an instance using the builder pattern
ShoppingListUpdateAction Example to create a subtype instance using the builder pattern
ShoppingListUpdateActionBuilder
ShoppingListUpdateAction
 
ShoppingListUpdateBuilder Example to create an instance using the builder pattern
ShoppingListUpdate
 
Specify which ProductData attributes to use for estimating similarity and how to weigh them.
SimilarityMeasuresBuilder Example to create an instance using the builder pattern
Specify which ProductData attributes to use for estimating similarity and how to weigh them.
One part of a SimilarProductPair.
SimilarProductBuilder Example to create an instance using the builder pattern
One part of a SimilarProductPair.
SimilarProductMeta Example to create an instance using the builder pattern
SimilarProductMetaBuilder Example to create an instance using the builder pattern
SimilarProductMeta
A pair of SimilarProducts
SimilarProductPairBuilder Example to create an instance using the builder pattern
A pair of SimilarProducts
SimilarProductSearchRequest Example to create an instance using the builder pattern
SimilarProductSearchRequestBuilder Example to create an instance using the builder pattern
SimilarProductSearchRequest
SimilarProductSearchRequestMeta Example to create an instance using the builder pattern
SimilarProductSearchRequestMetaBuilder Example to create an instance using the builder pattern
SimilarProductSearchRequestMeta
SimilarProductsPagedQueryResult Example to create an instance using the builder pattern
SimilarProductsPagedQueryResultBuilder Example to create an instance using the builder pattern
SimilarProductsPagedQueryResult
Represents a URL path to poll to get the results of an Asynchronous Request.
SimilarProductsTaskStatusBuilder Example to create an instance using the builder pattern
Represents a URL path to poll to get the results of an Asynchronous Request.
AWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.
SnsDestinationBuilder Example to create an instance using the builder pattern
AWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.
 
Marker interface to generate a solution info for the Java SDK user agent.
SortableTrait
Values for the Source enumeration.
possible values of Source
AWS SQS is a pull-queue on AWS.
SqsDestinationBuilder Example to create an instance using the builder pattern
AWS SQS is a pull-queue on AWS.
 
Describes how the Cart Discount interacts with other Discounts.
StackingMode
possible values of StackingMode
possible values of StackingMode
StagedOrder Example to create an instance using the builder pattern
StagedOrderAddCustomLineItemAction Example to create an instance using the builder pattern
StagedOrderAddCustomLineItemActionBuilder Example to create an instance using the builder pattern
StagedOrderAddCustomLineItemAction
 
StagedOrderAddDeliveryAction Example to create an instance using the builder pattern
StagedOrderAddDeliveryActionBuilder Example to create an instance using the builder pattern
StagedOrderAddDeliveryAction
 
StagedOrderAddDiscountCodeAction Example to create an instance using the builder pattern
StagedOrderAddDiscountCodeActionBuilder Example to create an instance using the builder pattern
StagedOrderAddDiscountCodeAction
 
StagedOrderAddItemShippingAddressAction Example to create an instance using the builder pattern
StagedOrderAddItemShippingAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderAddItemShippingAddressAction
 
StagedOrderAddLineItemAction Example to create an instance using the builder pattern
StagedOrderAddLineItemActionBuilder Example to create an instance using the builder pattern
StagedOrderAddLineItemAction
 
StagedOrderAddParcelToDeliveryAction Example to create an instance using the builder pattern
StagedOrderAddParcelToDeliveryActionBuilder Example to create an instance using the builder pattern
StagedOrderAddParcelToDeliveryAction
 
StagedOrderAddPaymentAction Example to create an instance using the builder pattern
StagedOrderAddPaymentActionBuilder Example to create an instance using the builder pattern
StagedOrderAddPaymentAction
 
StagedOrderAddReturnInfoAction Example to create an instance using the builder pattern
StagedOrderAddReturnInfoActionBuilder Example to create an instance using the builder pattern
StagedOrderAddReturnInfoAction
 
StagedOrderAddShoppingListAction Example to create an instance using the builder pattern
StagedOrderAddShoppingListActionBuilder Example to create an instance using the builder pattern
StagedOrderAddShoppingListAction
 
StagedOrderBuilder Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemMoneyAction Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemMoneyActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemMoneyAction
 
StagedOrderChangeCustomLineItemQuantityAction Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemQuantityActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemQuantityAction
 
StagedOrderChangeLineItemQuantityAction Example to create an instance using the builder pattern
StagedOrderChangeLineItemQuantityActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeLineItemQuantityAction
 
StagedOrderChangeOrderStateAction Example to create an instance using the builder pattern
StagedOrderChangeOrderStateActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeOrderStateAction
 
StagedOrderChangePaymentStateAction Example to create an instance using the builder pattern
StagedOrderChangePaymentStateActionBuilder Example to create an instance using the builder pattern
StagedOrderChangePaymentStateAction
 
StagedOrderChangeShipmentStateAction Example to create an instance using the builder pattern
StagedOrderChangeShipmentStateActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeShipmentStateAction
 
StagedOrderChangeTaxCalculationModeAction Example to create an instance using the builder pattern
StagedOrderChangeTaxCalculationModeActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeTaxCalculationModeAction
 
StagedOrderChangeTaxModeAction Example to create an instance using the builder pattern
StagedOrderChangeTaxModeActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeTaxModeAction
 
StagedOrderChangeTaxRoundingModeAction Example to create an instance using the builder pattern
StagedOrderChangeTaxRoundingModeActionBuilder Example to create an instance using the builder pattern
StagedOrderChangeTaxRoundingModeAction
 
StagedOrder
StagedOrderImportCustomLineItemStateAction Example to create an instance using the builder pattern
StagedOrderImportCustomLineItemStateActionBuilder Example to create an instance using the builder pattern
StagedOrderImportCustomLineItemStateAction
 
StagedOrderImportLineItemStateAction Example to create an instance using the builder pattern
StagedOrderImportLineItemStateActionBuilder Example to create an instance using the builder pattern
StagedOrderImportLineItemStateAction
 
 
StagedOrderRemoveCustomLineItemAction Example to create an instance using the builder pattern
StagedOrderRemoveCustomLineItemActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveCustomLineItemAction
 
StagedOrderRemoveDeliveryAction Example to create an instance using the builder pattern
StagedOrderRemoveDeliveryActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveDeliveryAction
 
StagedOrderRemoveDiscountCodeAction Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeAction
 
StagedOrderRemoveItemShippingAddressAction Example to create an instance using the builder pattern
StagedOrderRemoveItemShippingAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveItemShippingAddressAction
 
StagedOrderRemoveLineItemAction Example to create an instance using the builder pattern
StagedOrderRemoveLineItemActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveLineItemAction
 
StagedOrderRemoveParcelFromDeliveryAction Example to create an instance using the builder pattern
StagedOrderRemoveParcelFromDeliveryActionBuilder Example to create an instance using the builder pattern
StagedOrderRemoveParcelFromDeliveryAction
 
StagedOrderRemovePaymentAction Example to create an instance using the builder pattern
StagedOrderRemovePaymentActionBuilder Example to create an instance using the builder pattern
StagedOrderRemovePaymentAction
 
StagedOrderSetBillingAddressAction Example to create an instance using the builder pattern
StagedOrderSetBillingAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderSetBillingAddressAction
 
StagedOrderSetBillingAddressCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldAction
 
StagedOrderSetBillingAddressCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeAction
 
StagedOrderSetCountryAction Example to create an instance using the builder pattern
StagedOrderSetCountryActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCountryAction
 
StagedOrderSetCustomerEmailAction Example to create an instance using the builder pattern
StagedOrderSetCustomerEmailActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomerEmailAction
 
StagedOrderSetCustomerGroupAction Example to create an instance using the builder pattern
StagedOrderSetCustomerGroupActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomerGroupAction
 
StagedOrderSetCustomerIdAction Example to create an instance using the builder pattern
StagedOrderSetCustomerIdActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomerIdAction
 
StagedOrderSetCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomFieldAction
 
StagedOrderSetCustomLineItemCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldAction
 
StagedOrderSetCustomLineItemCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeAction
 
StagedOrderSetCustomLineItemShippingDetailsAction Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsAction
 
StagedOrderSetCustomLineItemTaxAmountAction Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemTaxAmountActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemTaxAmountAction
 
StagedOrderSetCustomLineItemTaxRateAction Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemTaxRateActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemTaxRateAction
 
StagedOrderSetCustomShippingMethodAction Example to create an instance using the builder pattern
StagedOrderSetCustomShippingMethodActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomShippingMethodAction
 
StagedOrderSetCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetCustomTypeAction
 
StagedOrderSetDeliveryAddressAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressAction
 
StagedOrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldAction
 
StagedOrderSetDeliveryAddressCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeAction
 
StagedOrderSetDeliveryCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldAction
 
StagedOrderSetDeliveryCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeAction
 
StagedOrderSetDeliveryItemsAction Example to create an instance using the builder pattern
StagedOrderSetDeliveryItemsActionBuilder Example to create an instance using the builder pattern
StagedOrderSetDeliveryItemsAction
 
StagedOrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldAction
 
StagedOrderSetItemShippingAddressCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeAction
 
StagedOrderSetLineItemCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldAction
 
StagedOrderSetLineItemCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeAction
 
StagedOrderSetLineItemDistributionChannelAction Example to create an instance using the builder pattern
StagedOrderSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemDistributionChannelAction
 
StagedOrderSetLineItemPriceAction Example to create an instance using the builder pattern
StagedOrderSetLineItemPriceActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemPriceAction
 
StagedOrderSetLineItemShippingDetailsAction Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsAction
 
StagedOrderSetLineItemTaxAmountAction Example to create an instance using the builder pattern
StagedOrderSetLineItemTaxAmountActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemTaxAmountAction
 
StagedOrderSetLineItemTaxRateAction Example to create an instance using the builder pattern
StagedOrderSetLineItemTaxRateActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemTaxRateAction
 
StagedOrderSetLineItemTotalPriceAction Example to create an instance using the builder pattern
StagedOrderSetLineItemTotalPriceActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLineItemTotalPriceAction
 
StagedOrderSetLocaleAction Example to create an instance using the builder pattern
StagedOrderSetLocaleActionBuilder Example to create an instance using the builder pattern
StagedOrderSetLocaleAction
 
StagedOrderSetOrderNumberAction Example to create an instance using the builder pattern
StagedOrderSetOrderNumberActionBuilder Example to create an instance using the builder pattern
StagedOrderSetOrderNumberAction
 
StagedOrderSetOrderTotalTaxAction Example to create an instance using the builder pattern
StagedOrderSetOrderTotalTaxActionBuilder Example to create an instance using the builder pattern
StagedOrderSetOrderTotalTaxAction
 
StagedOrderSetParcelCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldAction
 
StagedOrderSetParcelCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeAction
 
StagedOrderSetParcelItemsAction Example to create an instance using the builder pattern
StagedOrderSetParcelItemsActionBuilder Example to create an instance using the builder pattern
StagedOrderSetParcelItemsAction
 
StagedOrderSetParcelMeasurementsAction Example to create an instance using the builder pattern
StagedOrderSetParcelMeasurementsActionBuilder Example to create an instance using the builder pattern
StagedOrderSetParcelMeasurementsAction
 
StagedOrderSetParcelTrackingDataAction Example to create an instance using the builder pattern
StagedOrderSetParcelTrackingDataActionBuilder Example to create an instance using the builder pattern
StagedOrderSetParcelTrackingDataAction
 
StagedOrderSetPurchaseOrderNumberAction Example to create an instance using the builder pattern
StagedOrderSetPurchaseOrderNumberActionBuilder Example to create an instance using the builder pattern
StagedOrderSetPurchaseOrderNumberAction
 
StagedOrderSetReturnInfoAction Example to create an instance using the builder pattern
StagedOrderSetReturnInfoActionBuilder Example to create an instance using the builder pattern
StagedOrderSetReturnInfoAction
 
StagedOrderSetReturnItemCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldAction
 
StagedOrderSetReturnItemCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeAction
 
StagedOrderSetReturnPaymentStateAction Example to create an instance using the builder pattern
StagedOrderSetReturnPaymentStateActionBuilder Example to create an instance using the builder pattern
StagedOrderSetReturnPaymentStateAction
 
StagedOrderSetReturnShipmentStateAction Example to create an instance using the builder pattern
StagedOrderSetReturnShipmentStateActionBuilder Example to create an instance using the builder pattern
StagedOrderSetReturnShipmentStateAction
 
StagedOrderSetShippingAddressAction Example to create an instance using the builder pattern
StagedOrderSetShippingAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingAddressAction
 
StagedOrderSetShippingAddressAndCustomShippingMethodAction Example to create an instance using the builder pattern
StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingAddressAndCustomShippingMethodAction
 
StagedOrderSetShippingAddressAndShippingMethodAction Example to create an instance using the builder pattern
StagedOrderSetShippingAddressAndShippingMethodActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingAddressAndShippingMethodAction
 
StagedOrderSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldAction
 
StagedOrderSetShippingAddressCustomTypeAction Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeAction
 
StagedOrderSetShippingMethodAction Example to create an instance using the builder pattern
StagedOrderSetShippingMethodActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingMethodAction
 
StagedOrderSetShippingMethodTaxAmountAction Example to create an instance using the builder pattern
StagedOrderSetShippingMethodTaxAmountActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingMethodTaxAmountAction
 
StagedOrderSetShippingMethodTaxRateAction Example to create an instance using the builder pattern
StagedOrderSetShippingMethodTaxRateActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingMethodTaxRateAction
 
StagedOrderSetShippingRateInputAction Example to create an instance using the builder pattern
StagedOrderSetShippingRateInputActionBuilder Example to create an instance using the builder pattern
StagedOrderSetShippingRateInputAction
 
StagedOrderTransitionCustomLineItemStateAction Example to create an instance using the builder pattern
StagedOrderTransitionCustomLineItemStateActionBuilder Example to create an instance using the builder pattern
StagedOrderTransitionCustomLineItemStateAction
 
StagedOrderTransitionLineItemStateAction Example to create an instance using the builder pattern
StagedOrderTransitionLineItemStateActionBuilder Example to create an instance using the builder pattern
StagedOrderTransitionLineItemStateAction
 
StagedOrderTransitionStateAction Example to create an instance using the builder pattern
StagedOrderTransitionStateActionBuilder Example to create an instance using the builder pattern
StagedOrderTransitionStateAction
 
StagedOrderUpdateAction Example to create a subtype instance using the builder pattern
StagedOrderUpdateActionBuilder
StagedOrderUpdateAction
 
StagedOrderUpdateItemShippingAddressAction Example to create an instance using the builder pattern
StagedOrderUpdateItemShippingAddressActionBuilder Example to create an instance using the builder pattern
StagedOrderUpdateItemShippingAddressAction
 
StagedOrderUpdateSyncInfoAction Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoActionBuilder Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoAction
 
StagedQuote Example to create an instance using the builder pattern
StagedQuoteBuilder Example to create an instance using the builder pattern
StagedQuoteChangeStagedQuoteStateAction Example to create an instance using the builder pattern
StagedQuoteChangeStagedQuoteStateActionBuilder Example to create an instance using the builder pattern
StagedQuoteChangeStagedQuoteStateAction
 
Generated after a successful Create Staged Quote request.
StagedQuoteCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Staged Quote request.
Generated after a successful Create Staged Quote request.
StagedQuoteCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Staged Quote request.
 
 
Generated after a successful Delete Staged Quote request.
StagedQuoteDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Staged Quote request.
Generated after a successful Delete Staged Quote request.
StagedQuoteDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Staged Quote request.
 
 
StagedQuoteDraft Example to create an instance using the builder pattern
StagedQuoteDraftBuilder Example to create an instance using the builder pattern
StagedQuoteDraft
 
StagedQuote
StagedQuoteLabel Example to create an instance using the builder pattern
StagedQuoteLabelBuilder Example to create an instance using the builder pattern
StagedQuoteLabel
PagedQueryResult with results containing an array of StagedQuote.
StagedQuotePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of StagedQuote.
 
 
Reference to a StagedQuote.
StagedQuoteReferenceBuilder Example to create an instance using the builder pattern
Reference to a StagedQuote.
 
ResourceIdentifier to a StagedQuote.
StagedQuoteResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a StagedQuote.
 
Generated after a successful Set Seller Comment update action.
StagedQuoteSellerCommentSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Seller Comment update action.
Generated after a successful Set Seller Comment update action.
StagedQuoteSellerCommentSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Seller Comment update action.
 
 
StagedQuoteSetCustomFieldAction Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldActionBuilder Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldAction
 
StagedQuoteSetCustomTypeAction Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeActionBuilder Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeAction
 
StagedQuoteSetSellerCommentAction Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentActionBuilder Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentAction
 
StagedQuoteSetValidToAction Example to create an instance using the builder pattern
StagedQuoteSetValidToActionBuilder Example to create an instance using the builder pattern
StagedQuoteSetValidToAction
 
Predefined states tracking the status of the Staged Quote.
StagedQuoteState
possible values of StagedQuoteState
possible values of StagedQuoteState
Generated after a successful Change Staged Quote State update action.
StagedQuoteStateChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Staged Quote State update action.
Generated after a successful Change Staged Quote State update action.
StagedQuoteStateChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Staged Quote State update action.
 
 
Generated after a successful Transition State update action.
StagedQuoteStateTransitionMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Generated after a successful Transition State update action.
StagedQuoteStateTransitionMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
 
 
If the existing State has set transitions, there must be a direct transition to the new State.
StagedQuoteTransitionStateActionBuilder Example to create an instance using the builder pattern
If the existing State has set transitions, there must be a direct transition to the new State.
 
StagedQuoteUpdate Example to create an instance using the builder pattern
StagedQuoteUpdateAction Example to create a subtype instance using the builder pattern
StagedQuoteUpdateActionBuilder
StagedQuoteUpdateAction
 
StagedQuoteUpdateBuilder Example to create an instance using the builder pattern
StagedQuoteUpdate
 
Generated after a successful Set Valid To update action.
StagedQuoteValidToSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid To update action.
Generated after a successful Set Valid To update action.
StagedQuoteValidToSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid To update action.
 
 
Staged changes on a Standalone Price.
StagedStandalonePriceBuilder Example to create an instance using the builder pattern
Staged changes on a Standalone Price.
 
StandalonePrice Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
StandalonePriceActiveChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
Generated after a successful Change Active update action.
StandalonePriceActiveChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
 
 
Adding a PriceTier to a StandalonePrice produces the Standalone Price Tier Added Message.
StandalonePriceAddPriceTierActionBuilder Example to create an instance using the builder pattern
Adding a PriceTier to a StandalonePrice produces the Standalone Price Tier Added Message.
 
Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the StagedStandalonePrice.
StandalonePriceApplyStagedChangesActionBuilder Example to create an instance using the builder pattern
Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the StagedStandalonePrice.
 
StandalonePriceBuilder Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceActiveChangedMessage.
StandalonePriceChangeActiveActionBuilder Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceActiveChangedMessage.
 
Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
StandalonePriceChangeValueActionBuilder Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
 
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
 
 
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
 
 
Generated after a Product Discount is successfully applied to a StandalonePrice.
StandalonePriceDiscountSetMessageBuilder Example to create an instance using the builder pattern
Generated after a Product Discount is successfully applied to a StandalonePrice.
Generated after a Product Discount is successfully applied to a StandalonePrice.
StandalonePriceDiscountSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a Product Discount is successfully applied to a StandalonePrice.
 
 
Standalone Prices are defined with a scope consisting of currency and optionally country, customerGroup, and channel and/or a validity period (validFrom and/or validTo).
StandalonePriceDraftBuilder Example to create an instance using the builder pattern
Standalone Prices are defined with a scope consisting of currency and optionally country, customerGroup, and channel and/or a validity period (validFrom and/or validTo).
 
Generated after a successful Set Discounted Price update action.
StandalonePriceExternalDiscountSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
Generated after a successful Set Discounted Price update action.
StandalonePriceExternalDiscountSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
 
 
StandalonePrice
The data representation for a Standalone Price to be imported that is persisted as a Standalone Price in the Project.
StandalonePriceImportBuilder Example to create an instance using the builder pattern
The data representation for a Standalone Price to be imported that is persisted as a Standalone Price in the Project.
The request body to import Standalone Prices.
StandalonePriceImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Standalone Prices.
Generated after a successful Set Key update action.
StandalonePriceKeySetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
Generated after a successful Set Key update action.
StandalonePriceKeySetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
 
 
 
StandalonePricePagedQueryResponse Example to create an instance using the builder pattern
StandalonePricePagedQueryResponseBuilder Example to create an instance using the builder pattern
StandalonePricePagedQueryResponse
 
 
Reference to a StandalonePrice.
StandalonePriceReferenceBuilder Example to create an instance using the builder pattern
Reference to a StandalonePrice.
 
Removing a PriceTier from a StandalonePrice produces the Standalone Price Tier Removed Message.
StandalonePriceRemovePriceTierActionBuilder Example to create an instance using the builder pattern
Removing a PriceTier from a StandalonePrice produces the Standalone Price Tier Removed Message.
 
ResourceIdentifier to a StandalonePrice.
StandalonePriceResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a StandalonePrice.
 
StandalonePriceSetCustomFieldAction Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldActionBuilder Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldAction
 
StandalonePriceSetCustomTypeAction Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeActionBuilder Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeAction
 
Discounts a Standalone Price.
StandalonePriceSetDiscountedPriceActionBuilder Example to create an instance using the builder pattern
Discounts a Standalone Price.
 
Sets the key on a Standalone Price.
StandalonePriceSetKeyActionBuilder Example to create an instance using the builder pattern
Sets the key on a Standalone Price.
 
Sets all PriceTiers for a StandalonePrice in one action, produces the Standalone Price Tiers Set Message.
StandalonePriceSetPriceTiersActionBuilder Example to create an instance using the builder pattern
Sets all PriceTiers for a StandalonePrice in one action, produces the Standalone Price Tiers Set Message.
 
Updating the validFrom value generates the StandalonePriceValidFromSet Message.
StandalonePriceSetValidFromActionBuilder Example to create an instance using the builder pattern
Updating the validFrom value generates the StandalonePriceValidFromSet Message.
 
Updating the validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.
StandalonePriceSetValidFromAndUntilActionBuilder Example to create an instance using the builder pattern
Updating the validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.
 
Updating the validUntil value generates the StandalonePriceValidUntilSet Message.
StandalonePriceSetValidUntilActionBuilder Example to create an instance using the builder pattern
Updating the validUntil value generates the StandalonePriceValidUntilSet Message.
 
Generated after a successful Apply Staged Changes update action.
StandalonePriceStagedChangesAppliedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Apply Staged Changes update action.
Generated after a successful Apply Staged Changes update action.
StandalonePriceStagedChangesAppliedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Apply Staged Changes update action.
 
 
Generated after a successful Add Price Tier update action
StandalonePriceTierAddedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Price Tier update action
Generated after a successful Add Price Tier update action
StandalonePriceTierAddedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Price Tier update action
 
 
Generated after a successful Remove Price Tier update action
StandalonePriceTierRemovedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Price Tier update action
Generated after a successful Remove Price Tier update action
StandalonePriceTierRemovedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Remove Price Tier update action
 
 
Generated after a successful Set Price Tier update action
StandalonePriceTiersSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Price Tier update action
Generated after a successful Set Price Tier update action
StandalonePriceTiersSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Price Tier update action
 
 
StandalonePriceUpdate Example to create an instance using the builder pattern
StandalonePriceUpdateAction Example to create a subtype instance using the builder pattern
StandalonePriceUpdateActionBuilder
StandalonePriceUpdateAction
 
StandalonePriceUpdateBuilder Example to create an instance using the builder pattern
StandalonePriceUpdate
 
Generated after a successful Set Valid From and Until update action.
StandalonePriceValidFromAndUntilSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid From and Until update action.
Generated after a successful Set Valid From and Until update action.
StandalonePriceValidFromAndUntilSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid From and Until update action.
 
 
Generated after a successful Set Valid From update action.
StandalonePriceValidFromSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid From update action.
Generated after a successful Set Valid From update action.
StandalonePriceValidFromSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid From update action.
 
 
Generated after a successful Set Valid Until update action.
StandalonePriceValidUntilSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid Until update action.
Generated after a successful Set Valid Until update action.
StandalonePriceValidUntilSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Valid Until update action.
 
 
Generated after a successful Change Value update action.
StandalonePriceValueChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Change Value update action.
Generated after a successful Change Value update action.
StandalonePriceValueChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Change Value update action.
 
 
State Example to create an instance using the builder pattern
StateAddRolesAction Example to create an instance using the builder pattern
StateAddRolesActionBuilder Example to create an instance using the builder pattern
StateAddRolesAction
 
StateBuilder Example to create an instance using the builder pattern
StateChangeInitialAction Example to create an instance using the builder pattern
StateChangeInitialActionBuilder Example to create an instance using the builder pattern
StateChangeInitialAction
 
StateChangeKeyAction Example to create an instance using the builder pattern
StateChangeKeyActionBuilder Example to create an instance using the builder pattern
StateChangeKeyAction
 
StateChangeTypeAction Example to create an instance using the builder pattern
StateChangeTypeActionBuilder Example to create an instance using the builder pattern
StateChangeTypeAction
 
StateDraft Example to create an instance using the builder pattern
StateDraftBuilder Example to create an instance using the builder pattern
StateDraft
 
State
References a state by key.
StateKeyReferenceBuilder Example to create an instance using the builder pattern
References a state by key.
 
PagedQueryResult with results containing an array of State.
StatePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of State.
 
 
Reference to a State.
StateReferenceBuilder Example to create an instance using the builder pattern
Reference to a State.
 
StateRemoveRolesAction Example to create an instance using the builder pattern
StateRemoveRolesActionBuilder Example to create an instance using the builder pattern
StateRemoveRolesAction
 
ResourceIdentifier to a State.
StateResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a State.
 
StateRole
possible values of StateRole
For some resource types, a State can fulfill the following predefined roles:
possible values of StateRoleEnum
StateSetDescriptionAction Example to create an instance using the builder pattern
StateSetDescriptionActionBuilder Example to create an instance using the builder pattern
StateSetDescriptionAction
 
StateSetNameAction Example to create an instance using the builder pattern
StateSetNameActionBuilder Example to create an instance using the builder pattern
StateSetNameAction
 
StateSetRolesAction Example to create an instance using the builder pattern
StateSetRolesActionBuilder Example to create an instance using the builder pattern
StateSetRolesAction
 
StateSetTransitionsAction Example to create an instance using the builder pattern
StateSetTransitionsActionBuilder Example to create an instance using the builder pattern
StateSetTransitionsAction
 
StateType
possible values of StateType
Resource or object type the State can be assigned to.
possible values of StateTypeEnum
StateUpdate Example to create an instance using the builder pattern
StateUpdateAction Example to create a subtype instance using the builder pattern
StateUpdateActionBuilder
StateUpdateAction
 
StateUpdateBuilder Example to create an instance using the builder pattern
StateUpdate
 
Token supplier using a specified token
Store Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
StoreAddCountryActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
 
This update action produces the StoreDistributionChannelsChanged Message.
StoreAddDistributionChannelActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
 
To make all included Products available to your customers of a given Store, add the Product Selections to the respective Store.
StoreAddProductSelectionActionBuilder Example to create an instance using the builder pattern
To make all included Products available to your customers of a given Store, add the Product Selections to the respective Store.
 
This action has no effect if a given supply channel is already present in a Store.
StoreAddSupplyChannelActionBuilder Example to create an instance using the builder pattern
This action has no effect if a given supply channel is already present in a Store.
 
StoreBuilder Example to create an instance using the builder pattern
ProductSelection in a Store can be activated or deactivated using this update action.
StoreChangeProductSelectionActionBuilder Example to create an instance using the builder pattern
ProductSelection in a Store can be activated or deactivated using this update action.
 
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountriesChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Country, Remove Country, or Set Countries update action.
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountriesChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Country, Remove Country, or Set Countries update action.
 
 
StoreCountry Example to create an instance using the builder pattern
StoreCountry Example to create an instance using the builder pattern
StoreCountryBuilder Example to create an instance using the builder pattern
StoreCountryBuilder Example to create an instance using the builder pattern
StoreCountry
StoreCountry
 
Generated after a successful Create Store request.
StoreCreatedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Create Store request.
Generated after a successful Create Store request.
StoreCreatedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Create Store request.
 
 
Generated after a successful Delete Store request.
StoreDeletedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
Generated after a successful Delete Store request.
StoreDeletedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
 
 
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
StoreDistributionChannelsChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
StoreDistributionChannelsChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
 
 
StoreDraft Example to create an instance using the builder pattern
StoreDraftBuilder Example to create an instance using the builder pattern
StoreDraft
 
Store
Reference to a Store by its key.
References a store by key.
StoreKeyReferenceBuilder Example to create an instance using the builder pattern
StoreKeyReferenceBuilder Example to create an instance using the builder pattern
Reference to a Store by its key.
References a store by key.
 
Generated after a successful Set Languages update action.
StoreLanguagesChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Languages update action.
Generated after a successful Set Languages update action.
StoreLanguagesChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Languages update action.
 
 
 
Generated after a successful Set Name update action.
StoreNameSetMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
Generated after a successful Set Name update action.
StoreNameSetMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
 
 
PagedQueryResult with results containing an array of Store.
StorePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Store.
 
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
StoreProductSelectionsChangedMessageBuilder Example to create an instance using the builder pattern
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
StoreProductSelectionsChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
 
 
StoreprojectingTrait
 
Reference to a Store.
StoreReferenceBuilder Example to create an instance using the builder pattern
Reference to a Store.
 
This update action produces the StoreCountriesChanged Message.
StoreRemoveCountryActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
 
This update action produces the StoreDistributionChannelsChanged Message.
StoreRemoveDistributionChannelActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
 
This action has no effect if the given Product Selection is not in the Store.
StoreRemoveProductSelectionActionBuilder Example to create an instance using the builder pattern
This action has no effect if the given Product Selection is not in the Store.
 
This update action produces the StoreSupplyChannelsChanged Message.
StoreRemoveSupplyChannelActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreSupplyChannelsChanged Message.
 
ResourceIdentifier to a Store.
StoreResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Store.
 
This update action produces the StoreCountriesChanged Message.
StoreSetCountriesActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
 
StoreSetCustomFieldAction Example to create an instance using the builder pattern
StoreSetCustomFieldActionBuilder Example to create an instance using the builder pattern
StoreSetCustomFieldAction
 
StoreSetCustomTypeAction Example to create an instance using the builder pattern
StoreSetCustomTypeActionBuilder Example to create an instance using the builder pattern
StoreSetCustomTypeAction
 
This update action produces the StoreDistributionChannelsChanged Message.
StoreSetDistributionChannelsActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
 
This update action produces the StoreLanguagesChanged Message.
StoreSetLanguagesActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreLanguagesChanged Message.
 
This update action produces the StoreNameSet Message.
StoreSetNameActionBuilder Example to create an instance using the builder pattern
This update action produces the StoreNameSet Message.
 
Instead of adding or removing Product Selections individually, you can also change all the Store's Product Selections in one go using this update action.
StoreSetProductSelectionsActionBuilder Example to create an instance using the builder pattern
Instead of adding or removing Product Selections individually, you can also change all the Store's Product Selections in one go using this update action.
 
Setting a supply channel produces the StoreSupplyChannelsChanged Message.
StoreSetSupplyChannelsActionBuilder Example to create an instance using the builder pattern
Setting a supply channel produces the StoreSupplyChannelsChanged Message.
 
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
StoreSupplyChannelsChangedMessageBuilder Example to create an instance using the builder pattern
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
StoreSupplyChannelsChangedMessagePayloadBuilder Example to create an instance using the builder pattern
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
 
 
StoreUpdate Example to create an instance using the builder pattern
StoreUpdateAction Example to create a subtype instance using the builder pattern
StoreUpdateActionBuilder
StoreUpdateAction
 
StoreUpdateBuilder Example to create an instance using the builder pattern
StoreUpdate
 
 
 
 
A field with a string value.
StringFieldBuilder Example to create an instance using the builder pattern
A field with a string value.
StringLabel Example to create an instance using the builder pattern
StringLabelBuilder Example to create an instance using the builder pattern
StringLabel
A field with a string set value.
StringSetFieldBuilder Example to create an instance using the builder pattern
A field with a string set value.
It is used to calculate the taxPortions field in a Cart or Order.
SubRate Example to create an instance using the builder pattern
SubRate Example to create an instance using the builder pattern
SubRateBuilder Example to create an instance using the builder pattern
SubRateBuilder Example to create an instance using the builder pattern
SubRateBuilder Example to create an instance using the builder pattern
It is used to calculate the taxPortions field in a Cart or Order.
SubRate
SubRate
 
Subscription Example to create an instance using the builder pattern
SubscriptionBuilder Example to create an instance using the builder pattern
A test message is sent to ensure the correct configuration of the Destination.
SubscriptionChangeDestinationActionBuilder Example to create an instance using the builder pattern
A test message is sent to ensure the correct configuration of the Destination.
 
Deprecated.
use DeliveryPayload instead
Either messages or changes must be set.
SubscriptionDraftBuilder Example to create an instance using the builder pattern
Either messages or changes must be set.
 
The health status of the Subscription that indicates whether messages are being delivered to the Destination.
possible values of SubscriptionHealthStatus
Subscription
PagedQueryResult with results containing an array of Subscription.
SubscriptionPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Subscription.
 
 
SubscriptionSetChangesAction Example to create an instance using the builder pattern
SubscriptionSetChangesActionBuilder Example to create an instance using the builder pattern
SubscriptionSetChangesAction
 
SubscriptionSetKeyAction Example to create an instance using the builder pattern
SubscriptionSetKeyActionBuilder Example to create an instance using the builder pattern
SubscriptionSetKeyAction
 
SubscriptionSetMessagesAction Example to create an instance using the builder pattern
SubscriptionSetMessagesActionBuilder Example to create an instance using the builder pattern
SubscriptionSetMessagesAction
 
SubscriptionUpdate Example to create an instance using the builder pattern
SubscriptionUpdateAction Example to create a subtype instance using the builder pattern
SubscriptionUpdateActionBuilder
SubscriptionUpdateAction
 
SubscriptionUpdateBuilder Example to create an instance using the builder pattern
SubscriptionUpdate
 
Suggestion Example to create an instance using the builder pattern
SuggestionBuilder Example to create an instance using the builder pattern
Suggestion
 
SuggestionResult Example to create an instance using the builder pattern
SuggestionResultBuilder Example to create an instance using the builder pattern
SuggestionResult
 
SuggestTokenizer Example to create a subtype instance using the builder pattern
SuggestTokenizer Example to create an instance using the builder pattern
The tokenizer defines the tokens that are used to match against the Suggest Query input.
SuggestTokenizerBuilder
SuggestTokenizerBuilder Example to create an instance using the builder pattern
SuggestTokenizerBuilder
SuggestTokenizer
SuggestTokenizer
The tokenizer defines the tokens that are used to match against the Suggest Query input.
 
SyncInfo Example to create an instance using the builder pattern
SyncInfo Example to create an instance using the builder pattern
SyncInfo Example to create an instance using the builder pattern
SyncInfoBuilder Example to create an instance using the builder pattern
SyncInfoBuilder Example to create an instance using the builder pattern
SyncInfoBuilder Example to create an instance using the builder pattern
SyncInfo
SyncInfo
SyncInfo
 
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
SyntaxErrorErrorBuilder Example to create an instance using the builder pattern
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
 
TaskStatusEnum
possible values of TaskStatusEnum
Represents a URL path to poll to get the results of an Asynchronous Request.
TaskTokenBuilder Example to create an instance using the builder pattern
Represents a URL path to poll to get the results of an Asynchronous Request.
Determines in which Tax calculation mode taxed prices are calculated.
TaxCalculationMode
Maps to Order.taxCalculationMode.
possible values of TaxCalculationMode
possible values of TaxCalculationMode
possible values of TaxCalculationMode
TaxCategory Example to create an instance using the builder pattern
TaxCategoryAddTaxRateAction Example to create an instance using the builder pattern
TaxCategoryAddTaxRateActionBuilder Example to create an instance using the builder pattern
TaxCategoryAddTaxRateAction
 
TaxCategoryBuilder Example to create an instance using the builder pattern
TaxCategoryChangeNameAction Example to create an instance using the builder pattern
TaxCategoryChangeNameActionBuilder Example to create an instance using the builder pattern
TaxCategoryChangeNameAction
 
TaxCategoryDraft Example to create an instance using the builder pattern
TaxCategoryDraftBuilder Example to create an instance using the builder pattern
TaxCategoryDraft
 
TaxCategory
References a tax category by key.
TaxCategoryKeyReferenceBuilder Example to create an instance using the builder pattern
References a tax category by key.
 
PagedQueryResult with results containing an array of TaxCategory.
TaxCategoryPagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of TaxCategory.
 
 
Reference to a TaxCategory.
TaxCategoryReferenceBuilder Example to create an instance using the builder pattern
Reference to a TaxCategory.
 
TaxCategoryRemoveTaxRateAction Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateActionBuilder Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateAction
 
TaxCategoryReplaceTaxRateAction Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateActionBuilder Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateAction
 
ResourceIdentifier to a TaxCategory.
TaxCategoryResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a TaxCategory.
 
TaxCategorySetDescriptionAction Example to create an instance using the builder pattern
TaxCategorySetDescriptionActionBuilder Example to create an instance using the builder pattern
TaxCategorySetDescriptionAction
 
TaxCategorySetKeyAction Example to create an instance using the builder pattern
TaxCategorySetKeyActionBuilder Example to create an instance using the builder pattern
TaxCategorySetKeyAction
 
TaxCategoryUpdate Example to create an instance using the builder pattern
TaxCategoryUpdateAction Example to create a subtype instance using the builder pattern
TaxCategoryUpdateActionBuilder
TaxCategoryUpdateAction
 
TaxCategoryUpdateBuilder Example to create an instance using the builder pattern
TaxCategoryUpdate
 
TaxedItemPrice Example to create an instance using the builder pattern
TaxedItemPrice Example to create an instance using the builder pattern
TaxedItemPriceBuilder Example to create an instance using the builder pattern
TaxedItemPriceBuilder Example to create an instance using the builder pattern
TaxedItemPriceDraft Example to create an instance using the builder pattern
TaxedItemPriceDraftBuilder Example to create an instance using the builder pattern
TaxedItemPriceDraft
 
TaxedItemPrice
TaxedItemPrice
 
TaxedPrice Example to create an instance using the builder pattern
TaxedPrice Example to create an instance using the builder pattern
TaxedPrice Example to create an instance using the builder pattern
TaxedPriceBuilder Example to create an instance using the builder pattern
TaxedPriceBuilder Example to create an instance using the builder pattern
TaxedPriceBuilder Example to create an instance using the builder pattern
TaxedPriceDraft Example to create an instance using the builder pattern
TaxedPriceDraftBuilder Example to create an instance using the builder pattern
TaxedPriceDraft
 
TaxedPrice
TaxedPrice
TaxedPrice
 
Indicates how taxes are set on the Cart.
TaxMode
Maps to Order.taxMode
possible values of TaxMode
possible values of TaxMode
possible values of TaxMode
The tax portions are calculated from the TaxRates.
TaxPortion Example to create an instance using the builder pattern
TaxPortionBuilder Example to create an instance using the builder pattern
TaxPortionBuilder Example to create an instance using the builder pattern
Represents the portions that sum up to the totalGross field of a TaxedPrice.
TaxPortionDraftBuilder Example to create an instance using the builder pattern
Represents the portions that sum up to the totalGross field of a TaxedPrice.
 
The tax portions are calculated from the TaxRates.
TaxPortion
 
TaxRate Example to create an instance using the builder pattern
Shape of the value for addTaxRate and removeTaxRate actions
TaxRate Example to create an instance using the builder pattern
TaxRateBuilder Example to create an instance using the builder pattern
TaxRateBuilder Example to create an instance using the builder pattern
TaxRateBuilder Example to create an instance using the builder pattern
TaxRateDraft Example to create an instance using the builder pattern
TaxRateDraftBuilder Example to create an instance using the builder pattern
TaxRateDraft
 
TaxRate
Shape of the value for addTaxRate and removeTaxRate actions
TaxRate
 
 
TermFacetResult Example to create an instance using the builder pattern
TermFacetResultBuilder Example to create an instance using the builder pattern
TermFacetResult
 
TermFacetResultType
possible values of TermFacetResultType
This type represents an attribute whose value is a string.
TextAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a string.
A text input hint is a string with one of the following values:
TextInputHint
TextInputHint
possible values of TextInputHint
possible values of TextInputHint
possible values of TextInputHint
TextLineItems are Line Items that use text values instead of references to Products.
TextLineItem Example to create an instance using the builder pattern
TextLineItemBuilder Example to create an instance using the builder pattern
TextLineItemBuilder Example to create an instance using the builder pattern
TextLineItemDraft Example to create an instance using the builder pattern
TextLineItemDraftBuilder Example to create an instance using the builder pattern
TextLineItemDraft
 
TextLineItems are Line Items that use text values instead of references to Products.
TextLineItem
 
TextLineItemValue Example to create an instance using the builder pattern
TextLineItemValueBuilder Example to create an instance using the builder pattern
TextLineItemValue
This type represents an attribute whose value is a set of strings.
TextSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of strings.
 
This type represents an attribute whose value is a time.
TimeAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a time.
 
 
A field with a time value.
TimeFieldBuilder Example to create an instance using the builder pattern
A field with a time value.
This type represents an attribute whose value is a set of times.
TimeSetAttributeBuilder Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of times.
A field with a time set value.
TimeSetFieldBuilder Example to create an instance using the builder pattern
A field with a time set value.
 
 
 
 
TrackingData Example to create an instance using the builder pattern
TrackingData Example to create an instance using the builder pattern
TrackingData Example to create an instance using the builder pattern
TrackingDataBuilder Example to create an instance using the builder pattern
TrackingDataBuilder Example to create an instance using the builder pattern
TrackingDataBuilder Example to create an instance using the builder pattern
TrackingData
TrackingData
TrackingData
 
Represents a financial transaction typically created as a result of a notification from the payment service.
Transaction Example to create an instance using the builder pattern
TransactionBuilder Example to create an instance using the builder pattern
TransactionBuilder Example to create an instance using the builder pattern
TransactionChangeValue Example to create an instance using the builder pattern
TransactionChangeValueBuilder Example to create an instance using the builder pattern
TransactionChangeValue
TransactionDraft Example to create an instance using the builder pattern
TransactionDraftBuilder Example to create an instance using the builder pattern
TransactionDraft
 
Represents a financial transaction typically created as a result of a notification from the payment service.
Transaction
 
Transactions can be in one of the following States:
TransactionState
possible values of TransactionState
possible values of TransactionState
TransactionType
TransactionType
possible values of TransactionType
possible values of TransactionType
Change triggered by the following update actions:
TransitionCustomLineItemStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
TransitionLineItemStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Change triggered by the following update actions:
TransitionStateChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
Type Example to create an instance using the builder pattern
Adds a value to an EnumType.
TypeAddEnumValueActionBuilder Example to create an instance using the builder pattern
Adds a value to an EnumType.
 
Defines a new field for a Type.
TypeAddFieldDefinitionActionBuilder Example to create an instance using the builder pattern
Defines a new field for a Type.
 
Adds a value to a LocalizedEnumType.
TypeAddLocalizedEnumValueActionBuilder Example to create an instance using the builder pattern
Adds a value to a LocalizedEnumType.
 
TypeBuilder Example to create an instance using the builder pattern
Changes the label of an EnumValue of an EnumType FieldDefinition.
TypeChangeEnumValueLabelActionBuilder Example to create an instance using the builder pattern
Changes the label of an EnumValue of an EnumType FieldDefinition.
 
Changes the order of EnumValues in an EnumType FieldDefinition.
TypeChangeEnumValueOrderActionBuilder Example to create an instance using the builder pattern
Changes the order of EnumValues in an EnumType FieldDefinition.
 
TypeChangeFieldDefinitionOrderAction Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderActionBuilder Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderAction
 
Changes the inputHint of CustomFieldStringType FieldDefinition, a CustomFieldLocalizedStringType FieldDefinition, and CustomFieldSetType FieldDefinition of these string-based FieldTypes.
TypeChangeInputHintActionBuilder Example to create an instance using the builder pattern
Changes the inputHint of CustomFieldStringType FieldDefinition, a CustomFieldLocalizedStringType FieldDefinition, and CustomFieldSetType FieldDefinition of these string-based FieldTypes.
 
TypeChangeKeyAction Example to create an instance using the builder pattern
TypeChangeKeyActionBuilder Example to create an instance using the builder pattern
TypeChangeKeyAction
 
TypeChangeLabelAction Example to create an instance using the builder pattern
TypeChangeLabelActionBuilder Example to create an instance using the builder pattern
TypeChangeLabelAction
 
Changes the label of a LocalizedEnumValue of a LocalizedEnumType FieldDefinition.
TypeChangeLocalizedEnumValueLabelActionBuilder Example to create an instance using the builder pattern
Changes the label of a LocalizedEnumValue of a LocalizedEnumType FieldDefinition.
 
Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition.
TypeChangeLocalizedEnumValueOrderActionBuilder Example to create an instance using the builder pattern
Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition.
 
TypeChangeNameAction Example to create an instance using the builder pattern
TypeChangeNameActionBuilder Example to create an instance using the builder pattern
TypeChangeNameAction
 
Base polymorphic read-only Money type which is stored in cent precision or high precision.
TypedMoney Example to create a subtype instance using the builder pattern
TypedMoneyBuilder
TypedMoneyBuilder
TypedMoneyDraft Example to create a subtype instance using the builder pattern
TypedMoneyDraftBuilder
TypedMoneyDraft
 
Base polymorphic read-only Money type which is stored in cent precision or high precision.
TypedMoney
 
TypeDraft Example to create an instance using the builder pattern
TypeDraftBuilder Example to create an instance using the builder pattern
TypeDraft
 
Type
The data representation for a Type to be imported that is persisted as a Type in the Project.
TypeImportBuilder Example to create an instance using the builder pattern
The data representation for a Type to be imported that is persisted as a Type in the Project.
The request body to import Types.
TypeImportRequestBuilder Example to create an instance using the builder pattern
The request body to import Types.
References a type by key.
TypeKeyReferenceBuilder Example to create an instance using the builder pattern
References a type by key.
 
PagedQueryResult with results containing an array of Types.
TypePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Types.
 
 
Reference to a Type.
TypeReferenceBuilder Example to create an instance using the builder pattern
Reference to a Type.
 
TypeRemoveFieldDefinitionAction Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionActionBuilder Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionAction
 
ResourceIdentifier of a Type.
TypeResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier of a Type.
 
TypeSetDescriptionAction Example to create an instance using the builder pattern
TypeSetDescriptionActionBuilder Example to create an instance using the builder pattern
TypeSetDescriptionAction
 
Provides a visual representation type for this field.
Provides a visual representation type for this field.
possible values of TypeTextInputHint
possible values of TypeTextInputHint
TypeUpdate Example to create an instance using the builder pattern
TypeUpdateAction Example to create a subtype instance using the builder pattern
TypeUpdateActionBuilder
TypeUpdateAction
 
TypeUpdateBuilder Example to create an instance using the builder pattern
TypeUpdate
 
 
Change triggered when the format of changes on an entity is not identified by Audit Log.
UnknownChangeBuilder Example to create an instance using the builder pattern
Change triggered when the format of changes on an entity is not identified by Audit Log.
 
Change triggered by the Unpublish update action.
UnpublishChangeBuilder Example to create an instance using the builder pattern
Change triggered by the Unpublish update action.
UnresolvedReferences Example to create an instance using the builder pattern
UnresolvedReferencesBuilder Example to create an instance using the builder pattern
UnresolvedReferences
Update Example to create an instance using the builder pattern
UpdateAction Example to create an instance using the builder pattern
 
UpdateActionBuilder Example to create an instance using the builder pattern
UpdateAction
 
UpdateBuilder Example to create an instance using the builder pattern
Update
 
Change triggered by the following update actions:
UpdateSyncInfoChangeBuilder Example to create an instance using the builder pattern
Change triggered by the following update actions:
UpdateType
possible values of UpdateType
Middleware to add a user agent string as header to a request
User-provided identifiers present on the resource for which the Message is created.
UserProvidedIdentifiersBuilder Example to create an instance using the builder pattern
User-provided identifiers present on the resource for which the Message is created.
 
Table of content
 
ValidFromAndUntilValue Example to create an instance using the builder pattern
ValidFromAndUntilValueBuilder Example to create an instance using the builder pattern
ValidFromAndUntilValue
 
Variant Example to create an instance using the builder pattern
VariantBuilder Example to create an instance using the builder pattern
 
Variant
VariantValues Example to create an instance using the builder pattern
VariantValues Example to create an instance using the builder pattern
VariantValuesBuilder Example to create an instance using the builder pattern
VariantValuesBuilder Example to create an instance using the builder pattern
VariantValues
VariantValues
 
Change triggered by a Customer email verification.
VerifyEmailChangeBuilder Example to create an instance using the builder pattern
Change triggered by a Customer email verification.
 
VersionedTrait
Wrapper interface for a HTTP client
Deprecated.
use JsonUtils instead
Deprecated.
Deprecated.
Creates tokens by splitting the text field in SearchKeyword by whitespaces.
WhitespaceTokenizer Example to create an instance using the builder pattern
WhitespaceTokenizerBuilder Example to create an instance using the builder pattern
WhitespaceTokenizerBuilder Example to create an instance using the builder pattern
Creates tokens by splitting the text field in SearchKeyword by whitespaces.
WhitespaceTokenizer
 
 
an object with a localized Slug
 
Zone Example to create an instance using the builder pattern
ZoneAddLocationAction Example to create an instance using the builder pattern
ZoneAddLocationActionBuilder Example to create an instance using the builder pattern
ZoneAddLocationAction
 
ZoneBuilder Example to create an instance using the builder pattern
ZoneChangeNameAction Example to create an instance using the builder pattern
ZoneChangeNameActionBuilder Example to create an instance using the builder pattern
ZoneChangeNameAction
 
 
Deserializer converting string to ZonedDateTime
 
ZoneDraft Example to create an instance using the builder pattern
ZoneDraftBuilder Example to create an instance using the builder pattern
ZoneDraft
 
Zone
 
PagedQueryResult with results containing an array of Zone.
ZonePagedQueryResponseBuilder Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Zone.
 
 
Defines shipping rates in different currencies for a specific Zone.
ZoneRateBuilder Example to create an instance using the builder pattern
ZoneRateDraft Example to create an instance using the builder pattern
ZoneRateDraftBuilder Example to create an instance using the builder pattern
ZoneRateDraft
 
Defines shipping rates in different currencies for a specific Zone.
 
Reference to a Zone.
ZoneReferenceBuilder Example to create an instance using the builder pattern
Reference to a Zone.
 
ZoneRemoveLocationAction Example to create an instance using the builder pattern
ZoneRemoveLocationActionBuilder Example to create an instance using the builder pattern
ZoneRemoveLocationAction
 
ResourceIdentifier to a Zone.
ZoneResourceIdentifierBuilder Example to create an instance using the builder pattern
ResourceIdentifier to a Zone.
 
ZoneSetDescriptionAction Example to create an instance using the builder pattern
ZoneSetDescriptionActionBuilder Example to create an instance using the builder pattern
ZoneSetDescriptionAction
 
ZoneSetKeyAction Example to create an instance using the builder pattern
ZoneSetKeyActionBuilder Example to create an instance using the builder pattern
ZoneSetKeyAction
 
ZoneUpdate Example to create an instance using the builder pattern
ZoneUpdateAction Example to create a subtype instance using the builder pattern
ZoneUpdateActionBuilder
ZoneUpdateAction
 
ZoneUpdateBuilder Example to create an instance using the builder pattern
ZoneUpdate